createDashboardTab()

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

createDashboardTab() 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 CreateDashboardTab command.

Signature:

export declare function createDashboardTab(title?: string, index?: number, shouldStartRenaming?: boolean, correlationId?: string): ICreateDashboardTab;

Parameters

Parameter	Type	Description
title	string	(Optional) optional title for the new tab
index	number	(Optional) optional position to insert tab (defaults to end)
shouldStartRenaming	boolean	(Optional) optional flag to indicate whether the new tab should be started in renaming mode
correlationId	string	(Optional) specify correlation id to use for this command

Returns:

ICreateDashboardTab

create dashboard tab command