IAnalyticalDesignerOptionsAction
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
An action in the options menu.
export interface IAnalyticalDesignerOptionsAction
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) Why the action is disabled. | ||
string | (ALPHA) Stable identifier of the item. Built-in actions are | ||
boolean | (ALPHA) Whether the action is disabled. | ||
string | (ALPHA) Label of the action. | ||
() => void | (ALPHA) Starts the action. A built-in action starts its usual flow, such as an export dialog, and ignores the call while it is disabled. | ||
“action” | (ALPHA) |
Property details
IAnalyticalDesignerOptionsAction.disabledTooltippropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Why the action is disabled.
disabledTooltip?: string;
IAnalyticalDesignerOptionsAction.idpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Stable identifier of the item. Built-in actions are openInAnalyticalDesigner, exportXlsx, exportPdf, exportCsv, exportCsvRaw and changeTimezone. Prefix a custom identifier with custom:.
id: string;
IAnalyticalDesignerOptionsAction.isDisabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the action is disabled.
isDisabled: boolean;
IAnalyticalDesignerOptionsAction.labelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Label of the action.
label: string;
IAnalyticalDesignerOptionsAction.onSelectpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Starts the action. A built-in action starts its usual flow, such as an export dialog, and ignores the call while it is disabled.
onSelect: () => void;
IAnalyticalDesignerOptionsAction.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
type: "action";