addSectionItem()

Home > @gooddata/sdk-ui-dashboard > addSectionItem

addSectionItem() function

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates the AddSectionItems command.

Signature:

export declare function addSectionItem(sectionIndex: number, itemIndex: number, item: DashboardItemDefinition, autoResolveDateFilterDataset?: boolean, correlationId?: string): AddSectionItems;

Parameters

Parameter	Type	Description
sectionIndex	number	index of section to which the new item should be added
itemIndex	number	index at which to insert the new item
item	DashboardItemDefinition	definition of the new item.
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:

AddSectionItems

Remarks

Dispatching this command will result in addition of a new item into the existing section. This item may be a placeholder for KPI or insight, an actual dashboard widget or a previously stashed dashboard item.

This command operates only on the root layout. For nested layouts, use addNestedLayoutSectionItem().