Interface ReportingBookmarkState<T>

Shape of the persisted report state returned as ReportSetup.savedState when a saved configuration (bookmark) is restored. Produced by lx.publishState() and automatically serialized by the framework.

  • customState — the value last passed to lx.publishState(); null if never set
  • filters — saved facet filter states keyed by facet context key
  • views — saved view selections per context
  • customDropdownSelections — saved legacy dropdown selections (deprecated UI pattern)
interface ReportingBookmarkState {
    customDropdownSelections?: ReportDropdownSelections;
    customState?: null | T;
    filters: {
        [key: string]: BookmarkFilter;
    };
    tableConfig?: TableConfig;
    tableSortings?: Sorting[];
    timeline?: TimelineBookmarkSelection;
    views: {
        [context: string]: {
            activeViewKey?: string;
            factSheetType?: string;
            viewOption?: ViewOption;
        };
    };
}

Type Parameters

  • T = any

Properties

customDropdownSelections? customState? filters tableConfig? tableSortings? timeline? views

Properties

Optional customDropdownSelections

customDropdownSelections?: ReportDropdownSelections

Optional customState

customState?: null | T

filters

filters: {
    [key: string]: BookmarkFilter;
}

Type declaration

Optional tableConfig

tableConfig?: TableConfig

Optional tableSortings

tableSortings?: Sorting[]

Optional timeline

timeline?: TimelineBookmarkSelection

Deprecated

views

views: {
    [context: string]: {
        activeViewKey?: string;
        factSheetType?: string;
        viewOption?: ViewOption;
    };
}

Type declaration

  • [context: string]: {
        activeViewKey?: string;
        factSheetType?: string;
        viewOption?: ViewOption;
    }
    • Optional activeViewKey?: string
    • Optional factSheetType?: string
    • Optional viewOption?: ViewOption

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc