The requested page is not available for the requested platform. You are viewing the content for Default platform.

UrlStateExtensionOptions Interface

Provides options for customizing the UrlStateExtension.

Declaration

export interface UrlStateExtensionOptions

Properties

includeDashboardIdToUrl Property

Specifies whether the dashboard id is included in the Web Dashboard's URL.

Declaration

includeDashboardIdToUrl?: boolean

Property Value

Type Description
boolean

true, to include the dashboard id in the Web Dashboard's URL; otherwise, false.

includeDashboardStateToUrl Property

Specifies whether the dashboard state (such as the master filtering state) is included in the Web Dashboard's URL.

Declaration

includeDashboardStateToUrl?: boolean

Property Value

Type Description
boolean

true, to include the dashboard state in the Web Dashboard's URL; otherwise, false.

Remarks

Note that the includeDashboardStateToUrl property is in effect when the DashboardControlOptions.workingMode is set to WorkingMode.Viewer or WorkingMode.ViewerOnly.