addNestedLayoutSection()
Home > @gooddata/sdk-ui-dashboard > addNestedLayoutSection
addNestedLayoutSection() function
This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the AddLayoutSection command.
Signature:
export declare function addNestedLayoutSection(index: ILayoutSectionPath, initialHeader?: IDashboardLayoutSectionHeader, initialItems?: DashboardItemDefinition[], autoResolveDateFilterDataset?: boolean, correlationId?: string): AddLayoutSection;
Parameters
| Parameter | Type | Description |
|---|---|---|
| index | ILayoutSectionPath | index to place the section at; -1 can be used as convenience to append a new section |
| initialHeader | IDashboardLayoutSectionHeader | (Optional) specify header for the newly created section |
| initialItems | DashboardItemDefinition[] | (Optional) specify one or more items that the newly created section should include from the get-go |
| autoResolveDateFilterDataset | boolean | (Optional) specify whether dashboard should auto-resolve date dataset to use for date filtering of KPI and insight widgets; default is disabled meaning date filtering will be enabled only for those KPI or Insight widgets that already specify dateDataset. |
| correlationId | string | (Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns:
Remarks
Dispatching this command will result in the addition of a new layout section. The new section will be placed at the desired index and will be empty by default.
You may optionally specify the initial values of the section header and the items that will be in the new section.