IScheduledExportFiltersContextValue
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The scheduled-export dialog’s filter and export-parameter model: the current selection and available filters (flat and per tab), the handlers that mutate them, the staleness gate, and the export-parameter chips with their handlers.
Changes when a filter, a parameter or the store-filters toggle is edited; never per keystroke.
export interface IScheduledExportFiltersContextValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
() => void | (BETA) Resets the parameters to the dashboard’s current effective values (the “apply latest” flow). | ||
boolean | (BETA) False when the saved filters or the saved parameters no longer match the dashboard; gates the stale-filters confirmation. | ||
FilterContextItem[] | undefined | (BETA) The dashboard filters the schedule may use; undefined until resolved. | ||
Record<string, IAvailableAutomationParameter[]> | (BETA) Per-tab workspace parameters addable via the “+” menu. | ||
Record<string, FilterContextItem[]> | undefined | (BETA) The edited selection per dashboard tab (by-tab mode). | ||
boolean | (BETA) Whether the saved filters alone no longer match the dashboard. | ||
IAutomationFiltersTab[] | undefined | (BETA) Filters structured per dashboard tab; present with more than one tab. | ||
string | undefined | (BETA) The tab the flat (non-tabbed) UI edits; undefined for multi-tab dashboards or when no parameter context applies. | ||
() => void | (BETA) Replaces the selection with the dashboard’s current filters (the stale-filters repair). | ||
(newFiltersByTab: Record<string, FilterContextItem[]>, storeFiltersParam?: boolean) => void | (BETA) By-tab counterpart of | ||
(filters: FilterContextItem[], storeFiltersParam?: boolean) => void | (BETA) Replaces the selection with the complete updated array and mirrors it into the export definitions. | ||
(ref: IdentifierRef) => void | (BETA) Adds a workspace parameter with its default value on the flat tab. | ||
(tabId: string, ref: IdentifierRef) => void | (BETA) Adds a workspace parameter with its default value on the given tab. | ||
(ref: IdentifierRef, value: ParameterValue) => void | (BETA) Sets a parameter’s value on the flat tab. | ||
(tabId: string, ref: IdentifierRef, value: ParameterValue) => void | (BETA) Sets a parameter’s value on the given tab. | ||
(ref: IdentifierRef) => void | (BETA) Removes a parameter override on the flat tab. | ||
(tabId: string, ref: IdentifierRef) => void | (BETA) Removes a parameter override on the given tab. | ||
(value: boolean, filters?: FilterContextItem[], filtersByTabParam?: Record<string, FilterContextItem[]>) => void | (BETA) Toggles filter and parameter persistence. The current filters must be passed back — flat mode as | ||
(storeParameters: boolean) => void | (BETA) Re-encodes the parameters onto the automation with the new persistence value. | ||
boolean | (BETA) Whether the export-parameters feature is on; the parameter members below are empty when off. | ||
(BETA) The filters the schedule is saved with (flat mode). | |||
boolean | (BETA) Whether the schedule stores its own filters instead of using the latest saved dashboard filters. | ||
Record<string, IAutomationParameter[]> | (BETA) Per-tab visible parameters to render as chips. |
Property details
IScheduledExportFiltersContextValue.applyLatestpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Resets the parameters to the dashboard’s current effective values (the “apply latest” flow).
applyLatest: () => void;
IScheduledExportFiltersContextValue.automationIsValidpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
False when the saved filters or the saved parameters no longer match the dashboard; gates the stale-filters confirmation.
automationIsValid: boolean;
IScheduledExportFiltersContextValue.availableFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The dashboard filters the schedule may use; undefined until resolved.
availableFilters: FilterContextItem[] | undefined;
IScheduledExportFiltersContextValue.availableParametersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Per-tab workspace parameters addable via the “+” menu.
availableParametersByTab: Record<string, IAvailableAutomationParameter[]>;
IScheduledExportFiltersContextValue.editedFiltersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The edited selection per dashboard tab (by-tab mode).
editedFiltersByTab: Record<string, FilterContextItem[]> | undefined;
IScheduledExportFiltersContextValue.filtersAreStalepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Whether the saved filters alone no longer match the dashboard.
filtersAreStale: boolean;
IScheduledExportFiltersContextValue.filtersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Filters structured per dashboard tab; present with more than one tab.
filtersByTab: IAutomationFiltersTab[] | undefined;
IScheduledExportFiltersContextValue.flatTabIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The tab the flat (non-tabbed) UI edits; undefined for multi-tab dashboards or when no parameter context applies.
flatTabId: string | undefined;
IScheduledExportFiltersContextValue.onApplyCurrentFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Replaces the selection with the dashboard’s current filters (the stale-filters repair).
onApplyCurrentFilters: () => void;
IScheduledExportFiltersContextValue.onFiltersByTabChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
By-tab counterpart of onFiltersChange: replaces the per-tab selection wholesale.
onFiltersByTabChange: (newFiltersByTab: Record<string, FilterContextItem[]>, storeFiltersParam?: boolean) => void;
IScheduledExportFiltersContextValue.onFiltersChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Replaces the selection with the complete updated array and mirrors it into the export definitions. storeFiltersParam overrides the current toggle value for this write.
onFiltersChange: (filters: FilterContextItem[], storeFiltersParam?: boolean) => void;
IScheduledExportFiltersContextValue.onParameterAddpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Adds a workspace parameter with its default value on the flat tab.
onParameterAdd: (ref: IdentifierRef) => void;
IScheduledExportFiltersContextValue.onParameterAddByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Adds a workspace parameter with its default value on the given tab.
onParameterAddByTab: (tabId: string, ref: IdentifierRef) => void;
IScheduledExportFiltersContextValue.onParameterChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets a parameter’s value on the flat tab.
onParameterChange: (ref: IdentifierRef, value: ParameterValue) => void;
IScheduledExportFiltersContextValue.onParameterChangeByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets a parameter’s value on the given tab.
onParameterChangeByTab: (tabId: string, ref: IdentifierRef, value: ParameterValue) => void;
IScheduledExportFiltersContextValue.onParameterDeletepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Removes a parameter override on the flat tab.
onParameterDelete: (ref: IdentifierRef) => void;
IScheduledExportFiltersContextValue.onParameterDeleteByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Removes a parameter override on the given tab.
onParameterDeleteByTab: (tabId: string, ref: IdentifierRef) => void;
IScheduledExportFiltersContextValue.onStoreFiltersChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Toggles filter and parameter persistence. The current filters must be passed back — flat mode as (value, filters, undefined), by-tab mode as (value, undefined, filtersByTab).
onStoreFiltersChange: (value: boolean, filters?: FilterContextItem[], filtersByTabParam?: Record<string, FilterContextItem[]>) => void;
IScheduledExportFiltersContextValue.onStoreParametersChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Re-encodes the parameters onto the automation with the new persistence value.
onStoreParametersChange: (storeParameters: boolean) => void;
IScheduledExportFiltersContextValue.parametersEnabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Whether the export-parameters feature is on; the parameter members below are empty when off.
parametersEnabled: boolean;
IScheduledExportFiltersContextValue.selectedFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The filters the schedule is saved with (flat mode).
selectedFilters: FilterContextItem[];
IScheduledExportFiltersContextValue.storeFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Whether the schedule stores its own filters instead of using the latest saved dashboard filters.
storeFilters: boolean;
IScheduledExportFiltersContextValue.visibleParametersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Per-tab visible parameters to render as chips.
visibleParametersByTab: Record<string, IAutomationParameter[]>;