Documentation
    Preparing search index...

    Type Alias SliceInfo

    Metadata information for a data entity.

    type SliceInfo = {
        author: number;
        author_name: string;
        broken: number;
        category: string;
        connect: string;
        fid_params: {
            fields: { [key: string]: [string, any] };
            group: string[] | null;
            order: string[] | null;
            where: string[] | null;
        };
        fingerprint: string;
        id: number;
        meta: {
            mixinFids: number[];
            modified: number;
            presentation: {
                calendar: {
                    allDay: number;
                    colorBackfill: number;
                    dateInterval: string;
                    endTimeAttr: string;
                    firstDayOfWeek: number;
                    onEmptyRowClick: string;
                    onRowClick: string;
                    onRowClickNewTab: number;
                    showLabelTime: number;
                    startTimeAttr: string;
                    summaryAttr: string;
                };
                chart: { expression: string; subtitle: string };
                description: string;
                export: {
                    dateFormat: string;
                    dateTimeFormat: string;
                    delimiter: string;
                    enclosure: string;
                    fileName: string;
                    firstRowLabels: number;
                    includeRawWithPrettys: number;
                    prettyRelations: number;
                    removeSpecialsCharacters: number;
                    timeFormat: string;
                };
                fields: {
                    [key: string]: {
                        allowOther?: boolean;
                        append?: boolean;
                        changecase?: string
                        | "normal";
                        css?: string;
                        defaultValue?: string;
                        defaultValueType?: string;
                        description?: string;
                        doNotDuplicate?: boolean;
                        grid?: { columnOrder: number; width: number };
                        hide?: boolean;
                        hint?: string;
                        id?: string;
                        labelAlign?: "Left" | "Right" | "Center";
                        labelWidth?: string;
                        maxsize?: string;
                        name?: string;
                        newLine?: boolean;
                        options?: string[];
                        order?: number;
                        password?: boolean;
                        protectedColumn?: boolean;
                        qid?: number;
                        readonly?: boolean;
                        reportLabel?: string;
                        required?: boolean;
                        selected?: string;
                        showAudit?: boolean;
                        shrink?: boolean;
                        size?: string;
                        special?: string | "None";
                        spreadCols?: string;
                        style?: string;
                        text?: string;
                        type?: "boolean" | "string" | "string[]" | "number" | "Date";
                        unique?: boolean;
                        validation?: string | "None";
                    };
                };
                gantt: {
                    clockFormat: string;
                    endDateField: string;
                    label: string;
                    periodValue: number;
                    startDateField: string;
                    startValue: number;
                    yAxis: string;
                };
                graph: {
                    angle: string;
                    depth: number;
                    header: {
                        count: number;
                        summaryExpr: string;
                        title: string;
                        xSummary: string;
                        ySummary: string;
                    };
                    randomizeFill: number;
                    type: string;
                    x: string;
                    xAggregate: string;
                    y: string;
                    yAggregate: string;
                    yCurrency: number;
                    yPrecision: number;
                };
                grid: { cellColor: string[]; rowColor: string[]; totals: string[] };
                hideAddRecord: number;
                hideAddRelated: number;
                hideDeleteData: number;
                hideEdit: number;
                hideExport: number;
                hideHeader: number;
                hideHeaderButtons: number;
                hideHeaderTitle: number;
                hideOnLeftNav: number;
                hidePrint: number;
                hideSubscribe: number;
                hideView: number;
                include_in: number[];
                map: {
                    addressfield: string;
                    autoFitMarkers: number;
                    center: string;
                    clearmarkers: number;
                    latfield: string;
                    longfield: string;
                    optimizeRoute: number;
                    refreshrate: number;
                    showDirections: number;
                    zoom: number;
                };
                pie: {
                    decimalPlaces: number;
                    outer: {
                        label: string;
                        showCount: number;
                        showPercent: number;
                        showTotal: number;
                    };
                    subtitle: string;
                    subtitleIncludeTotal: number;
                    tooltip: {
                        label: string;
                        showCount: number;
                        showPercent: number;
                        showTotal: number;
                    };
                };
                pivot: { cell: string; column: string; key: string };
                refreshAuto: number;
                refreshInterval: number | null;
                reportType: string;
                showDescription: number;
                summaryGrid: number;
                titleBold: number;
                zoneMap: {
                    css: string;
                    expression: string;
                    hoverTemplate: string;
                    html: string;
                    keyField: string;
                    onHoverAction: string;
                    ratioX: null;
                    ratioY: null;
                    rotate: null;
                };
            };
        };
        modified: Date;
        name: string;
        owner_perms: number;
        parent?: number;
        pcol: string
        | null;
        query: {
            fields: { [key: string]: [string, any] };
            join: string | string[] | null;
            tables: { self: string };
        };
        query_members: {
            fields: { [key: string]: [string, any] };
            group: string | string[] | null;
            join: string | string[];
            order: string | string[] | null;
            tables: { self: string };
            where: string | string[] | null;
        };
        query_params: {
            fields: { [key: string]: [string, any] };
            group: string[] | null;
            order: string[] | null;
            where: string[] | null;
        };
        role?: string
        | null;
        source_db: string;
        source_pcol: string;
        source_table: string;
        types: {
            key: string;
            options?: string[];
            readonly: boolean;
            required: boolean;
            type: string;
        }[];
    }
    Index

    Properties

    author: number

    Author's user ID

    author_name: string

    Name of the author

    broken: number

    Broken flag (0/1)

    category: string

    Category of the entity

    connect: string

    Connection string or identifier

    fid_params: {
        fields: { [key: string]: [string, any] };
        group: string[] | null;
        order: string[] | null;
        where: string[] | null;
    }

    Parameters for field IDs.

    Type declaration

    • fields: { [key: string]: [string, any] }

      Field configs

    • group: string[] | null

      Group by fields

    • order: string[] | null

      Order by fields

    • where: string[] | null

      Where filters

    fingerprint: string

    Data fingerprint

    id: number

    Unique ID

    meta: {
        mixinFids: number[];
        modified: number;
        presentation: {
            calendar: {
                allDay: number;
                colorBackfill: number;
                dateInterval: string;
                endTimeAttr: string;
                firstDayOfWeek: number;
                onEmptyRowClick: string;
                onRowClick: string;
                onRowClickNewTab: number;
                showLabelTime: number;
                startTimeAttr: string;
                summaryAttr: string;
            };
            chart: { expression: string; subtitle: string };
            description: string;
            export: {
                dateFormat: string;
                dateTimeFormat: string;
                delimiter: string;
                enclosure: string;
                fileName: string;
                firstRowLabels: number;
                includeRawWithPrettys: number;
                prettyRelations: number;
                removeSpecialsCharacters: number;
                timeFormat: string;
            };
            fields: {
                [key: string]: {
                    allowOther?: boolean;
                    append?: boolean;
                    changecase?: string
                    | "normal";
                    css?: string;
                    defaultValue?: string;
                    defaultValueType?: string;
                    description?: string;
                    doNotDuplicate?: boolean;
                    grid?: { columnOrder: number; width: number };
                    hide?: boolean;
                    hint?: string;
                    id?: string;
                    labelAlign?: "Left" | "Right" | "Center";
                    labelWidth?: string;
                    maxsize?: string;
                    name?: string;
                    newLine?: boolean;
                    options?: string[];
                    order?: number;
                    password?: boolean;
                    protectedColumn?: boolean;
                    qid?: number;
                    readonly?: boolean;
                    reportLabel?: string;
                    required?: boolean;
                    selected?: string;
                    showAudit?: boolean;
                    shrink?: boolean;
                    size?: string;
                    special?: string | "None";
                    spreadCols?: string;
                    style?: string;
                    text?: string;
                    type?: "boolean" | "string" | "string[]" | "number" | "Date";
                    unique?: boolean;
                    validation?: string | "None";
                };
            };
            gantt: {
                clockFormat: string;
                endDateField: string;
                label: string;
                periodValue: number;
                startDateField: string;
                startValue: number;
                yAxis: string;
            };
            graph: {
                angle: string;
                depth: number;
                header: {
                    count: number;
                    summaryExpr: string;
                    title: string;
                    xSummary: string;
                    ySummary: string;
                };
                randomizeFill: number;
                type: string;
                x: string;
                xAggregate: string;
                y: string;
                yAggregate: string;
                yCurrency: number;
                yPrecision: number;
            };
            grid: { cellColor: string[]; rowColor: string[]; totals: string[] };
            hideAddRecord: number;
            hideAddRelated: number;
            hideDeleteData: number;
            hideEdit: number;
            hideExport: number;
            hideHeader: number;
            hideHeaderButtons: number;
            hideHeaderTitle: number;
            hideOnLeftNav: number;
            hidePrint: number;
            hideSubscribe: number;
            hideView: number;
            include_in: number[];
            map: {
                addressfield: string;
                autoFitMarkers: number;
                center: string;
                clearmarkers: number;
                latfield: string;
                longfield: string;
                optimizeRoute: number;
                refreshrate: number;
                showDirections: number;
                zoom: number;
            };
            pie: {
                decimalPlaces: number;
                outer: {
                    label: string;
                    showCount: number;
                    showPercent: number;
                    showTotal: number;
                };
                subtitle: string;
                subtitleIncludeTotal: number;
                tooltip: {
                    label: string;
                    showCount: number;
                    showPercent: number;
                    showTotal: number;
                };
            };
            pivot: { cell: string; column: string; key: string };
            refreshAuto: number;
            refreshInterval: number | null;
            reportType: string;
            showDescription: number;
            summaryGrid: number;
            titleBold: number;
            zoneMap: {
                css: string;
                expression: string;
                hoverTemplate: string;
                html: string;
                keyField: string;
                onHoverAction: string;
                ratioX: null;
                ratioY: null;
                rotate: null;
            };
        };
    }

    Additional metadata and presentation settings.

    Type declaration

    • mixinFids: number[]

      Field mixins (IDs)

    • modified: number

      Metadata last modified (timestamp)

    • presentation: {
          calendar: {
              allDay: number;
              colorBackfill: number;
              dateInterval: string;
              endTimeAttr: string;
              firstDayOfWeek: number;
              onEmptyRowClick: string;
              onRowClick: string;
              onRowClickNewTab: number;
              showLabelTime: number;
              startTimeAttr: string;
              summaryAttr: string;
          };
          chart: { expression: string; subtitle: string };
          description: string;
          export: {
              dateFormat: string;
              dateTimeFormat: string;
              delimiter: string;
              enclosure: string;
              fileName: string;
              firstRowLabels: number;
              includeRawWithPrettys: number;
              prettyRelations: number;
              removeSpecialsCharacters: number;
              timeFormat: string;
          };
          fields: {
              [key: string]: {
                  allowOther?: boolean;
                  append?: boolean;
                  changecase?: string
                  | "normal";
                  css?: string;
                  defaultValue?: string;
                  defaultValueType?: string;
                  description?: string;
                  doNotDuplicate?: boolean;
                  grid?: { columnOrder: number; width: number };
                  hide?: boolean;
                  hint?: string;
                  id?: string;
                  labelAlign?: "Left" | "Right" | "Center";
                  labelWidth?: string;
                  maxsize?: string;
                  name?: string;
                  newLine?: boolean;
                  options?: string[];
                  order?: number;
                  password?: boolean;
                  protectedColumn?: boolean;
                  qid?: number;
                  readonly?: boolean;
                  reportLabel?: string;
                  required?: boolean;
                  selected?: string;
                  showAudit?: boolean;
                  shrink?: boolean;
                  size?: string;
                  special?: string | "None";
                  spreadCols?: string;
                  style?: string;
                  text?: string;
                  type?: "boolean" | "string" | "string[]" | "number" | "Date";
                  unique?: boolean;
                  validation?: string | "None";
              };
          };
          gantt: {
              clockFormat: string;
              endDateField: string;
              label: string;
              periodValue: number;
              startDateField: string;
              startValue: number;
              yAxis: string;
          };
          graph: {
              angle: string;
              depth: number;
              header: {
                  count: number;
                  summaryExpr: string;
                  title: string;
                  xSummary: string;
                  ySummary: string;
              };
              randomizeFill: number;
              type: string;
              x: string;
              xAggregate: string;
              y: string;
              yAggregate: string;
              yCurrency: number;
              yPrecision: number;
          };
          grid: { cellColor: string[]; rowColor: string[]; totals: string[] };
          hideAddRecord: number;
          hideAddRelated: number;
          hideDeleteData: number;
          hideEdit: number;
          hideExport: number;
          hideHeader: number;
          hideHeaderButtons: number;
          hideHeaderTitle: number;
          hideOnLeftNav: number;
          hidePrint: number;
          hideSubscribe: number;
          hideView: number;
          include_in: number[];
          map: {
              addressfield: string;
              autoFitMarkers: number;
              center: string;
              clearmarkers: number;
              latfield: string;
              longfield: string;
              optimizeRoute: number;
              refreshrate: number;
              showDirections: number;
              zoom: number;
          };
          pie: {
              decimalPlaces: number;
              outer: {
                  label: string;
                  showCount: number;
                  showPercent: number;
                  showTotal: number;
              };
              subtitle: string;
              subtitleIncludeTotal: number;
              tooltip: {
                  label: string;
                  showCount: number;
                  showPercent: number;
                  showTotal: number;
              };
          };
          pivot: { cell: string; column: string; key: string };
          refreshAuto: number;
          refreshInterval: number | null;
          reportType: string;
          showDescription: number;
          summaryGrid: number;
          titleBold: number;
          zoneMap: {
              css: string;
              expression: string;
              hoverTemplate: string;
              html: string;
              keyField: string;
              onHoverAction: string;
              ratioX: null;
              ratioY: null;
              rotate: null;
          };
      }

      Presentation and view configuration.

      • calendar: {
            allDay: number;
            colorBackfill: number;
            dateInterval: string;
            endTimeAttr: string;
            firstDayOfWeek: number;
            onEmptyRowClick: string;
            onRowClick: string;
            onRowClickNewTab: number;
            showLabelTime: number;
            startTimeAttr: string;
            summaryAttr: string;
        }

        Calendar configuration

        • allDay: number

          All-day event flag

        • colorBackfill: number

          Enable color backfill

        • dateInterval: string

          Date interval string

        • endTimeAttr: string

          End time attribute

        • firstDayOfWeek: number

          First day of week (0=Sun)

        • onEmptyRowClick: string

          Action for empty row click

        • onRowClick: string

          Action on row click

        • onRowClickNewTab: number

          Open row click in new tab

        • showLabelTime: number

          Show label time flag

        • startTimeAttr: string

          Start time attribute

        • summaryAttr: string

          Event summary attribute

      • chart: { expression: string; subtitle: string }

        Chart configuration

        • expression: string

          Data expression

        • subtitle: string

          Chart subtitle

      • description: string

        Description text

      • export: {
            dateFormat: string;
            dateTimeFormat: string;
            delimiter: string;
            enclosure: string;
            fileName: string;
            firstRowLabels: number;
            includeRawWithPrettys: number;
            prettyRelations: number;
            removeSpecialsCharacters: number;
            timeFormat: string;
        }

        Export settings

        • dateFormat: string

          Date format

        • dateTimeFormat: string

          Date/time format

        • delimiter: string

          Value delimiter

        • enclosure: string

          Text enclosure character

        • fileName: string

          File name

        • firstRowLabels: number

          First row as labels flag

        • includeRawWithPrettys: number

          Include raw with prettys flag

        • prettyRelations: number

          Pretty print relations

        • removeSpecialsCharacters: number

          Remove special characters

        • timeFormat: string

          Time format

      • fields: {
            [key: string]: {
                allowOther?: boolean;
                append?: boolean;
                changecase?: string | "normal";
                css?: string;
                defaultValue?: string;
                defaultValueType?: string;
                description?: string;
                doNotDuplicate?: boolean;
                grid?: { columnOrder: number; width: number };
                hide?: boolean;
                hint?: string;
                id?: string;
                labelAlign?: "Left" | "Right" | "Center";
                labelWidth?: string;
                maxsize?: string;
                name?: string;
                newLine?: boolean;
                options?: string[];
                order?: number;
                password?: boolean;
                protectedColumn?: boolean;
                qid?: number;
                readonly?: boolean;
                reportLabel?: string;
                required?: boolean;
                selected?: string;
                showAudit?: boolean;
                shrink?: boolean;
                size?: string;
                special?: string | "None";
                spreadCols?: string;
                style?: string;
                text?: string;
                type?: "boolean" | "string" | "string[]" | "number" | "Date";
                unique?: boolean;
                validation?: string | "None";
            };
        }

        Settings for each field.

      • gantt: {
            clockFormat: string;
            endDateField: string;
            label: string;
            periodValue: number;
            startDateField: string;
            startValue: number;
            yAxis: string;
        }

        Gantt chart configuration

        • clockFormat: string

          Clock format

        • endDateField: string

          Name of end date field

        • label: string

          Label for gantt chart

        • periodValue: number

          Value for period

        • startDateField: string

          Name of start date field

        • startValue: number

          Start value (number)

        • yAxis: string

          Y-axis field name

      • graph: {
            angle: string;
            depth: number;
            header: {
                count: number;
                summaryExpr: string;
                title: string;
                xSummary: string;
                ySummary: string;
            };
            randomizeFill: number;
            type: string;
            x: string;
            xAggregate: string;
            y: string;
            yAggregate: string;
            yCurrency: number;
            yPrecision: number;
        }

        Graph configuration

        • angle: string

          Angle for the chart

        • depth: number

          Depth value

        • header: {
              count: number;
              summaryExpr: string;
              title: string;
              xSummary: string;
              ySummary: string;
          }

          Graph header info

          • count: number

            Total count

          • summaryExpr: string

            Summary expression

          • title: string

            Graph title

          • xSummary: string

            X summary

          • ySummary: string

            Y summary

        • randomizeFill: number

          Random fill flag

        • type: string

          Graph type

        • x: string

          X axis field

        • xAggregate: string

          X-axis aggregation

        • y: string

          Y axis field

        • yAggregate: string

          Y-axis aggregation

        • yCurrency: number

          Y axis currency flag

        • yPrecision: number

          Y axis precision

      • grid: { cellColor: string[]; rowColor: string[]; totals: string[] }

        Grid styling settings

        • cellColor: string[]

          Cell color settings

        • rowColor: string[]

          Row color settings

        • totals: string[]

          Total rows

      • hideAddRecord: number

        Hide add record button

      • hideAddRelated: number

        Hide add related button

      • hideDeleteData: number

        Hide delete data button

      • hideEdit: number

        Hide edit button

      • hideExport: number

        Hide export button

      • hideHeader: number

        Hide header

      • hideHeaderButtons: number

        Hide header buttons

      • hideHeaderTitle: number

        Hide header title

      • hideOnLeftNav: number

        Hide on left navigation

      • hidePrint: number

        Hide print button

      • hideSubscribe: number

        Hide subscribe button

      • hideView: number

        Hide view button

      • include_in: number[]

        IDs to include in presentation

      • map: {
            addressfield: string;
            autoFitMarkers: number;
            center: string;
            clearmarkers: number;
            latfield: string;
            longfield: string;
            optimizeRoute: number;
            refreshrate: number;
            showDirections: number;
            zoom: number;
        }

        Map display settings

        • addressfield: string

          Address field

        • autoFitMarkers: number

          Auto-fit markers flag

        • center: string

          Center coordinates

        • clearmarkers: number

          Clear markers flag

        • latfield: string

          Latitude field

        • longfield: string

          Longitude field

        • optimizeRoute: number

          Optimize route flag

        • refreshrate: number

          Refresh rate

        • showDirections: number

          Show directions flag

        • zoom: number

          Map zoom level

      • pie: {
            decimalPlaces: number;
            outer: {
                label: string;
                showCount: number;
                showPercent: number;
                showTotal: number;
            };
            subtitle: string;
            subtitleIncludeTotal: number;
            tooltip: {
                label: string;
                showCount: number;
                showPercent: number;
                showTotal: number;
            };
        }

        Pie chart options

        • decimalPlaces: number

          Decimal places

        • outer: { label: string; showCount: number; showPercent: number; showTotal: number }

          Outer label config

          • label: string

            Label text

          • showCount: number

            Show count value

          • showPercent: number

            Show percent value

          • showTotal: number

            Show total value

        • subtitle: string

          Pie subtitle

        • subtitleIncludeTotal: number

          Show total in subtitle

        • tooltip: { label: string; showCount: number; showPercent: number; showTotal: number }

          Tooltip config

          • label: string

            Tooltip label

          • showCount: number

            Show count in tooltip

          • showPercent: number

            Show percent in tooltip

          • showTotal: number

            Show total in tooltip

      • pivot: { cell: string; column: string; key: string }

        Pivot table settings

        • cell: string

          Cell value

        • column: string

          Column field

        • key: string

          Key field

      • refreshAuto: number

        Auto-refresh flag

      • refreshInterval: number | null

        Refresh interval in seconds, or null

      • reportType: string

        Report type

      • showDescription: number

        Show description flag

      • summaryGrid: number

        Summary grid flag

      • titleBold: number

        Bold title flag

      • zoneMap: {
            css: string;
            expression: string;
            hoverTemplate: string;
            html: string;
            keyField: string;
            onHoverAction: string;
            ratioX: null;
            ratioY: null;
            rotate: null;
        }

        Zone map settings

        • css: string

          Custom CSS

        • expression: string

          Zone expression

        • hoverTemplate: string

          Hover template HTML

        • html: string

          Custom HTML

        • keyField: string

          Key field

        • onHoverAction: string

          Hover action

        • ratioX: null

          X ratio (nullable)

        • ratioY: null

          Y ratio (nullable)

        • rotate: null

          Rotation (nullable)

    modified: Date

    Last modified date

    name: string

    Name of the entity

    owner_perms: number

    Owner permissions

    parent?: number

    Optional parent ID

    pcol: string | null

    Optional primary column

    query: {
        fields: { [key: string]: [string, any] };
        join: string | string[] | null;
        tables: { self: string };
    }

    Primary query.

    Type declaration

    • fields: { [key: string]: [string, any] }

      Query fields

    • join: string | string[] | null

      Join relations

    • tables: { self: string }

      Main table reference

    query_members: {
        fields: { [key: string]: [string, any] };
        group: string | string[] | null;
        join: string | string[];
        order: string | string[] | null;
        tables: { self: string };
        where: string | string[] | null;
    }

    Query settings for members.

    Type declaration

    • fields: { [key: string]: [string, any] }

      Fields for member queries

    • group: string | string[] | null

      Group by fields

    • join: string | string[]

      Join relations

    • order: string | string[] | null

      Order by fields

    • tables: { self: string }

      Member tables

    • where: string | string[] | null

      Where filters

    query_params: {
        fields: { [key: string]: [string, any] };
        group: string[] | null;
        order: string[] | null;
        where: string[] | null;
    }

    Query parameters.

    Type declaration

    • fields: { [key: string]: [string, any] }

      Query fields

    • group: string[] | null

      Group by fields

    • order: string[] | null

      Order by fields

    • where: string[] | null

      Where filters

    role?: string | null

    Optional role identifier

    source_db: string

    Source database name

    source_pcol: string

    Source primary column

    source_table: string

    Source table name

    types: {
        key: string;
        options?: string[];
        readonly: boolean;
        required: boolean;
        type: string;
    }[]

    Typescript type definitions

    Type declaration

    • key: string

      Property name

    • Optionaloptions?: string[]

      Value options

    • readonly: boolean

      Readonly value

    • required: boolean

      Required value

    • type: string

      Typescript type