IAutomationsParameters
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Workspace and dashboard parameter data provided by the dashboard connector so that the shared automationFilters hooks do not need to read dashboard selectors directly.
export interface IAutomationsParameters
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) The workspace parameter catalog; from selectCatalogParameters. | |||
boolean | (BETA) Whether the parameter catalog has finished loading. Before it has, every stored parameter ref looks removed, so staleness checks must treat loading as not-stale. | ||
Record<string, IDashboardParameter[]> | (BETA) Effective dashboard parameter values keyed by tab; from selectSmartPersistedTabsParameters. | ||
boolean | (BETA) Whether the parameters feature is enabled; from selectEnableParameters. | ||
boolean | (BETA) Whether STRING-typed parameters are enabled; from selectEnableStringParameters. |
Property details
IAutomationsParameters.catalogpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The workspace parameter catalog; from selectCatalogParameters.
catalog: IParameterMetadataObject[];
IAutomationsParameters.catalogIsLoadedpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether the parameter catalog has finished loading. Before it has, every stored parameter ref looks removed, so staleness checks must treat loading as not-stale.
catalogIsLoaded: boolean;
IAutomationsParameters.dashboardParametersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Effective dashboard parameter values keyed by tab; from selectSmartPersistedTabsParameters.
dashboardParametersByTab: Record<string, IDashboardParameter[]>;
IAutomationsParameters.enabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether the parameters feature is enabled; from selectEnableParameters.
enabled: boolean;
IAutomationsParameters.stringParametersEnabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether STRING-typed parameters are enabled; from selectEnableStringParameters.
stringParametersEnabled: boolean;