ICreateDashboardTabPayload
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Payload of the ICreateDashboardTab command.
export interface ICreateDashboardTabPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| number | (ALPHA) (Optional) Optional index at which the new tab should be inserted. Defaults to the end of the list. | |
| boolean | (ALPHA) (Optional) Optional flag to indicate whether the new tab should be started in renaming mode. | |
| string | (ALPHA) (Optional) Optional title for the new tab. If not provided, empty title will be used. |
Property details
ICreateDashboardTabPayload.indexpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional index at which the new tab should be inserted. Defaults to the end of the list.
readonly index?: number;
ICreateDashboardTabPayload.shouldStartRenamingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional flag to indicate whether the new tab should be started in renaming mode.
readonly shouldStartRenaming?: boolean;
ICreateDashboardTabPayload.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional title for the new tab. If not provided, empty title will be used.
readonly title?: string;