UrlStateExtensionOptions Interface

Provides options for customizing the UrlStateExtension.

Declaration

export interface UrlStateExtensionOptions

Remarks

See the following topic for information on how to use the DashboardControl’s client-side API: Extensions Overview.

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.

Note

The Web Dashboard automatically removes the dashboard state from a long URL string to avoid cases when the URL is truncated by a web browser.