addItemToPath()
Home > @gooddata/sdk-ui-dashboard > IFluidLayoutCustomizer > addItemToPath
IFluidLayoutCustomizer.addItemToPath() method
Adds a new item containing a custom widget onto the dashboard.
Signature:
addItemToPath(itemPath: ILayoutItemPath, item: IDashboardLayoutItem<ICustomWidget>): IFluidLayoutCustomizer;
Parameters
| Parameter | Type | Description |
|---|---|---|
| itemPath | ILayoutItemPath | layout path where to add new item |
| item | IDashboardLayoutItem<ICustomWidget> | item containing custom widget; note: customizer will make a deep copy of the item before adding it onto a dashboard. At this moment, the newly added items are read-only. |
Returns:
Remarks
New item will be added to position defined by provided path allowing target also nested layouts/sections. All sections in path already need to exist. The item to add must contain a custom widget data. Attempts to add item that does not contain any widget data will be ignored and warnings will be reported. Keep in mind that this can lead to further errors or problems down the line if you are adding more items at specific indexes into the same section.
Note: new items will be added into existing sections before new sections will be added using the IFluidLayoutCustomizer.addSection method. Therefore,