Kottster Packages API Reference
    Preparing search index...

    Interface DashboardPageConfigRatioStat

    interface DashboardPageConfigRatioStat {
        customDataFetcher?: (
            input: DashboardPageGetStatDataInput,
        ) => Promise<DashboardPageGetStatDataResult>;
        dataSource?: string;
        fetchStrategy: "rawSqlQuery" | "customFetch";
        infoTooltipText?: string;
        key: string;
        prefix?: string;
        span?: string;
        sqlQuery: string;
        sqlTotalQuery: string;
        suffix?: string;
        title: string;
        type: "ratio";
    }

    Hierarchy

    • DashboardPageConfigStatBase
      • DashboardPageConfigRatioStat
    Index

    Properties

    customDataFetcher? dataSource? fetchStrategy infoTooltipText? key prefix? span? sqlQuery sqlTotalQuery suffix? title type

    Properties

    customDataFetcher?: (
        input: DashboardPageGetStatDataInput,
    ) => Promise<DashboardPageGetStatDataResult>

    Custom fetcher function to retrieve data. The function should return values

    Type Declaration

    dataSource?: string
    fetchStrategy: "rawSqlQuery" | "customFetch"
    infoTooltipText?: string

    Info tooltip text for the state

    'This stat shows the total sales for the last month.'
    key: string
    prefix?: string

    Prefix for the value (goes before the value)

    span?: string

    Grid field span for the field in the form (12, 8, 6, 4)

    sqlQuery: string
    sqlTotalQuery: string
    suffix?: string

    Suffix for the value (goes after the value)

    title: string
    type: "ratio"

    Settings

    Member Visibility

    On This Page

    Properties