This document elaborates the API to create a complete dashboard interface using the designer and viewer components. You can create, edit, and save dashboards in dashboard designer and view dashboards in the dashboard viewer.

The following sections describe the module: dashboard/types.

Enumerations

• CommandName

• DesignerEventType

• EventType

• InteractionMouseEventAction

• ScenarioType

• Toolbar

Classes

• DashboardDesigner

• DashboardLiteViewer

• DashboardViewer

Interfaces

• UIContainer

• UIDashboard

• UIPage

• UIScenario

• UIWidget

Type Aliases

• CommandOption

• DashboardDesignerConfig

• DashboardDesignerDefaults

• DashboardDesignerFeatures

• DashboardDesignerInitOption

• DashboardLiteViewerConfig

• DashboardLiteViewerDefaults

• DashboardLiteViewerFeatures

• DashboardLiteViewerInitOption

• DashboardViewerConfig

• DashboardViewerDefaults

• DashboardViewerFeatures

• DashboardViewerInitOption

• DocumentSaveOption

• DocumentSyncOption

• DrillDownCommandPayload

• DrillResetCommandPayload

• DrillUpCommandPayload

• HideScenarioCommandPayload

• SceneConfig

• SceneDesignerConfig

• SceneDesignerInitOption

• SceneViewerConfig

• SceneViewerInitOption

• ShowScenarioCommandPayload

• SwitchPageCommandPayload

• SwitchTabCommandPayload

• ToggleScenarioCommandPayload

• WynBIOption

• WynDashboardApp

• WynDashboardAppType

• commonConfig

Enumerations

Enumeration: CommandName

The event name dashboard is supported.

Enumeration Members

Drill

• Drill = "Drill"

DrillDown

• DrillDown = "DrillDown"

DrillReset

• DrillReset = "ResetDrill"

DrillUp

• DrillUp = "DrillUp"

HideScenario

• HideScenario = "HideScenario"

ShowScenario

• ShowScenario = "ShowScenario"

SwitchPage

• SwitchPage = "SwitchPage"

SwitchTab

• SwitchTab = "SwitchTab"

ToggleScenario

• ToggleScenario = "ToggleScenario"

Enumeration: DesignerEventType

Enumeration Members

Close

• Close = "close"

Dashboard designer close event.

DatabindingPanelHidden

• DatabindingPanelHidden = "databindingPanelHidden"

Data binding panel hidden event.

DatabindingPanelShown

• DatabindingPanelShown = "databindingPanelShown"

Data binding panel display event.

Error

• Error = "error"

Dashboard designer error event.

InspectorShown

• InspectorShown = "inspectorShown"

Property panel display event.

InspectorHidden

• InspectorHidden = "inspectorHidden"

Property panel hidden event.

Loaded

• Loaded = "loaded"

Dashboard designer loading complete event.

MobileViewEntered

• MobileViewEntered = "mobileViewEntered"

Enter the mobile view event.

MobileViewExited

• MobileViewExited = "mobileViewExited"

Exit mobile view event.

PreviewEntered

• PreviewEntered = "previewEntered"

Enter the preview state event.

PreviewExited

• PreviewExited = "previewExited"

Exit preview state event.

Rendered

• Rendered = "rendered"

Dashboard designer rendering complete event.

Saved

• Saved = "saved"

Dashboard document save complete event.

Enumeration: EventType

Enumeration Members

Failed

• Failed = "failed"

Mounted

• Mounted = "mounted"

Render

• Render = "render"

Rendered

• Rendered = "rendered"

SelectionChange

• SelectionChange = "selectionChange"

Update

• Update = "update"

Enumeration: InteractionMouseEventAction

Enumeration Members

Enumeration Members

DrillTo

• DrillTo = "drillTo"

Exclude

• Exclude = "exclude"

JumpTo

• JumpTo = "jumpTo"

Keep

• Keep = "keep"

None

• None = "none"

ShowTooltip

• ShowTooltip = "showTooltip"

Enumeration: ScenarioType

Enumeration Members

Container

• Container = "container"

EmbeddedDashboard

• EmbeddedDashboard = "embeddedDashboard"

EmbeddedReport

• EmbeddedReport = "embeddedReport"

EmbeddedScene

• EmbeddedScene = "3DScene"

Group

• Group = "group"

MergedChart

• MergedChart = "mergedChart"

Picture

• Picture = "picture"

PivotChart

• PivotChart = "pivotChart"

RichEditor

• RichEditor = "richEditor"

Slicer

• Slicer = "slicer"

SpreadChart

• SpreadChart = "spreadChart"

TabContainer

• TabContainer = "tabContainer"

Visual

• Visual = "visual"

Enumeration: Toolbar

Enumeration Members

Auto

• Auto = "auto"

Default

• Default = "default"

Hide

• Hide = "hide"

Show

• Show = "show"

Classes

Class: DashboardDesigner

Constructor

• new DashboardDesigner(): DashboardDesigner

Returns

DashboardDesigner

Methods

addVisual

▸ addVisual(visualName, width?, height?, left?, top?): Promise<string>\

Adds a new scenario to the current document.

Parameters

Returns

Promise<string>

Sample Code

designer.addVisual( 
		visualName: 'column',
		width: 400,
		height: 300,
		left: 0,
		top: 0
);

addVisualByTemplateId

▸ addVisualByTemplateId(templateId, left?, top?): Promise<string>

Adds a new scenario by template to the current document.

Parameters

Returns

Promise<string>

Sample Code

designer.addVisualByTemplateId( 
		templateId: '658f8e5c-81a2-4a0c-a016-84ba52368b29',
		left: 0,
		top: 0
);

destroy

▸ destroy(): void

Releases the resources of the dashboard designer instance.

Returns

void

hideDataBindingPanel

▸ hideDataBindingPanel(): void

Hides the data binding panel of the dashboard designer.

Returns

void

hideInspector

▸ hideInspector(): void

Hides the inspector panel of the dashboard designer.

Returns

void

initialize

▸ initialize(initOption): Promise<void>

Initializes a designer instance and returns a promise.

Parameters

Returns

Promise<void>

Sample Code

	designer.initialize({
		container: document.querySelector("#dashboard"),
		defaults: {
			datasetId
		},
		features: {
			actionbarItems : ["focus","annotation","shareScenario"]
		},
		onLoaded: (docName) => { 
			document.title = docName;
		}
});

isDocumentDirty

▸ isDocumentDirty(): boolean

Returns a bool value indicating whether the state of the current document is dirty.

Returns

boolean

off

▸ off(eventType, eventHandler): void

Unsubscribes from a dashboard event.

Parameters

Returns

void

on

▸ on(eventType, eventHandler): void

Subscribes to a dashboard event.

Parameters

Returns

void

save

▸ save(option?): Promise<boolean>

Saves the current document.

Parameters

Returns

Promise<boolean>

Sample Code

designer.save({
		name: 'xxxxx',
		categories: ['xx'],
		comment: 'xxxx',
		shouldPublish: true
});

setDatasetId

▸ setDatasetId(datasetId): void

Specifies a dataset for the current scenario.

Parameters

Returns

void

showDataBindingPanel

▸ showDataBindingPanel(): void

Shows the data binding panel of the dashboard designer.

Returns

void

showInspector

▸ showInspector(): void

Shows the inspector panel of the dashboard designer.

Returns

void

togglePreview

▸ togglePreview(option?): void

Switches designer's view mode. If the designer is now in the 'Design' state, then it will go to the 'Preview' state, and vice versa.

Parameters

Returns

void

Class: DashboardLiteViewer

Constructors

• new DashboardLiteViewer(): DashboardLiteViewer

Returns

DashboardLiteViewer

Methods

destroy

▸ destroy(): void

Releases the resources of the Lite viewer instance.

Returns

void

executeCommand

▸ executeCommand(option): Promise<void>

Provides some events for users to control the current document.

Parameters

Returns

Promise<void>

Sample Code

	liteViewer.executeCommand({
		name: 'DrillDown', // or 'Drill'
		payload: {
			target: 'column',
			drillDimension: 'Region',
		}
}).then(() => {
		// drill down successfully
}).catch((err) => {
		console.log(err);
});

getDatasets

▸ getDatasets(): Promise<any[]>

Returns all the used datasets.

Returns

Promise<any[]>

getUIDashboard

▸ getUIDashboard(): UIDashboard

Returns UIDashboard instance.

Returns

UIDashboard

initialize

▸ initialize(initOption): Promise<any>

Initializes a Lite viewer instance and returns a promise.

Parameters

Returns

Promise< UIDashboard>

Sample Code

	liteViewer.initialize({
		container: document.querySelector("#dashboard"),
		defaults: {
			dashboardId: 'xxxxxx',
		},
		features: {
			actionbarItems : ["focus","annotation","shareScenario"]
		},
		onLoaded: (docName) => { 
			document.title = docName;
		}
});

requestFullScreen

▸ requestFullScreen(): void

Makes the current document enter full-screen mode.

Returns

void

setParameterValue

▸ setParameterValue(parameters): void

Sets parameter values for the current document.

Parameters

Returns

void

Sample code

viewer.setParameterValue({
		p1: ['product1'], 
		p2: [['dd1', '2018'], ['dd2', '2017']]
})

Class: DashboardViewer

Constructors

• new DashboardViewer(): DashboardViewer

Returns

DashboardViewer

Methods

destroy

▸ destroy(): void

Releases the resources of the viewer instance.

Returns

void

executeCommand

▸ executeCommand(option): Promise<void>

Provides some events for users to control the current document.

Parameters

Returns

Promise<void>

Sample Code

viewer.executeCommand({
		name: 'DrillDown', // or 'Drill'
		payload: {
			target: 'column',
			drillDimension: 'Region',
		}
}).then(() => {
		// drill down successfully
}).catch((err) => {
		console.log(err);
});

getDatasets

▸ getDatasets(): Promise<any[]>

Returns all the used datasets.

Returns

Promise<any[]>

initialize

▸ initialize(initOption): Promise<void>

Initializes a standard viewer instance and returns a promise.

Parameters

Returns

Promise<void>

Sample Code

viewer.initialize({
		container: document.querySelector("#viewer"),
		defaults: {
			dashboardId: 'xxxxxx',
		},
		features: {
			actionbarItems : ["focus","annotation","shareScenario"]
		},
		onLoaded: (docName) => { 
			document.title = docName;
		}
});

requestFullScreen

▸ requestFullScreen(): void

Makes the current document enter full-screen mode.

Returns

void

setParameterValue

▸ setParameterValue(parameters): void

Sets parameter values for the current document.

Parameters

Returns

void

Sample code

viewer.setParameterValue({
		p1: ['product1'], 
		p2: [['dd1', '2018'], ['dd2', '2017']]
})

Interfaces

Interface: UIContainer

Hierarchy

• UIWidget

  
  

  ↳ UIContainer

Properties

scenarioType

• scenarioType: ScenarioType

scenarios

• scenarios: UIScenario[]

Methods

connect

▸ connect(container): void

Parameters

Returns

void

Inherited from

UIWidget.connect

disconnect

▸ disconnect(): void

Returns

void

Inherited from

UIWidget.disconnect

getName

▸ getName(): string

Returns

string

Inherited from

UIWidget.getName

getScenarioByID

▸ getScenarioByID(scenarioID): UIScenario

Parameters

Returns

UIScenario

getScenarioByName

▸ getScenarioByName(scenarioName): UIScenario

Parameters

Returns

UIScenario

getTitle

▸ getTitle(): string

Returns

string

isConnected

▸ isConnected(): boolean

Returns

boolean

Inherited from

UIWidget.isConnected

off

▸ off(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.off

on

▸ on(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.on

once

▸ once(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.once

refresh

▸ refresh(): void

Returns

void

Inherited from

UIWidget.refresh

resize

▸ resize(): void

Returns

void

Inherited from

UIWidget.resize

resume

▸ resume(): void

Returns

void

Inherited from

UIWidget.resume

suspend

▸ suspend(): void

Returns

void

Inherited from

UIWidget.suspend

Interface: UIDashboard

Hierarchy

• UIWidget

  
  

  ↳ UIDashboard

Properties

pages

• pages: UIPage[]

Methods

connect

▸ connect(container): void

Parameters

Returns

void

Inherited from

UIWidget.connect

disconnect

▸ disconnect(): void

Returns

void

Inherited from

UIWidget.disconnect

getCurrentPage

▸ getCurrentPage(): UIPage

Returns

UIPage

getName

▸ getName(): string

Returns

string

Inherited from

UIWidget.getName

getPageByID

▸ getPageByID(id): UIPage

Parameters

Returns

UIPage

getPageByName

▸ getPageByName(pageName): UIPage

Parameters

Returns

UIPage

getScenarioByID

▸ getScenarioByID(scenarioID): UIScenario

Parameters

Returns

UIScenario

getScenarioByName

▸ getScenarioByName(scenarioName): UIScenario

Parameters

Returns

UIScenario

isConnected

▸ isConnected(): boolean

Returns

boolean

Inherited from

UIWidget.isConnected

off

▸ off(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.off

on

▸ on(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.on

once

▸ once(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.once

▸ refresh(): void

Returns

void

Inherited from

UIWidget.refresh

resize

▸ resize(): void

Returns

void

Inherited from

UIWidget.resize

resume

▸ resume(): void

Returns

void

Inherited from

UIWidget.resume

showNextPage

▸ showNextPage(): UIPage

Returns

UIPage

showPrevPage

▸ showPrevPage(): UIPage

Returns

UIPage

suspend

▸ suspend(): void

Returns

void

Inherited from

UIWidget.suspend

Interface: UIPage

Hierarchy

• UIWidget

  
  

  ↳ UIPage

Properties

containers

• containers: UIScenario[]

scenarios

• scenarios: UIScenario[]

widgets

• widgets: UIScenario[]

Methods

connect

▸ connect(container): void

Parameters

Returns

void

Inherited from

UIWidget.connect

disconnect

▸ disconnect(): void

Returns

void

Inherited from

UIWidget.disconnect

getName

▸ getName(): string

Returns

string

Inherited from

UIWidget.getName

getScenarioByID

▸ getScenarioByID(scenarioID): UIScenario

Parameters

Returns

UIScenario

getScenarioByName

▸ getScenarioByName(scenarioName): UIScenario

Parameters

Returns

UIScenario

isConnected

▸ isConnected(): boolean

Returns

boolean

Inherited from

UIWidget.isConnected

off

▸ off(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.off

on

▸ on(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.on

once

▸ once(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.once

refresh

▸ refresh(): void

Returns

void

Inherited from

UIWidget.refresh)

resize

▸ resize(): void

Returns

void

Inherited from

UIWidget.resize

resume

▸ resume(): void

Returns

void

Inherited from

UIWidget.resume

suspend

▸ suspend(): void

Returns

void

Inherited from

UIWidget.suspend

Interface: UIScenario

Hierarchy

• UIWidget

  
  

  ↳ UIScenario

Properties

scenarioType

• scenarioType: ScenarioType

Methods

connect

▸ connect(container): void

Parameters

Returns

void

Inherited from

UIWidget.connect

disconnect

▸ disconnect(): void

Returns

void

Inherited from

UIWidget.disconnect

getName

▸ getName(): string

Returns

string

Inherited from

UIWidget.getName

getTitle

▸ getTitle(): string

Returns

string

isConnected

▸ isConnected(): boolean

Returns

boolean

Inherited from

UIWidget.isConnected

off

▸ off(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.off

on

▸ on(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.on

once

▸ once(type, cb): void

Parameters

Returns

void

Inherited from

UIWidget.once

refresh

▸ refresh(): void

Returns

void

Inherited from

UIWidget.refresh

resize

▸ resize(): void

Returns

void

Inherited from

UIWidget.resize

resume

▸ resume(): void

Returns

void

Inherited from

UIWidget.resume

suspend

▸ suspend(): void

Returns

void

Inherited from

UIWidget.suspend

Interface: UIWidget

Hierarchy

• UIWidget

  
  

  ↳ UIScenario

  
  

  ↳ UIContainer

  
  

  ↳ UIPage

  
  

  ↳ UIDashboard

Methods

connect

▸ connect(container): void

Parameters

Returns

void

disconnect

▸ disconnect(): void

Returns

void

getName

▸ getName(): string

Returns

string

isConnected

▸ isConnected(): boolean

Returns

boolean

off

▸ off(type, cb): void

Parameters

Returns

void

on

▸ on(type, cb): void

Parameters

Returns

void

once

▸ once(type, cb): void

Parameters

Returns

void

refresh

▸ refresh(): void

Returns

void

resize

▸ resize(): void

Returns

void

resume

▸ resume(): void

Returns

void

suspend

▸ suspend(): void

Returns

void

Type Aliases

CommandOption

Ƭ CommandOption: Object

The options for executing the command.

Type declaration

name: CommandName

The event name of the command.

payload: SwitchTabCommandPayload | SwitchPageCommandPayload | DrillDownCommandPayload | DrillUpCommandPayload | DrillResetCommandPayload | ToggleScenarioCommandPayload | ShowScenarioCommandPayload | HideScenarioCommandPayload

The payload of each command.

DashboardDesignerConfig

Ƭ DashboardDesignerConfig: DashboardDesignerInitOption & Partial<DashboardDesignerDefaults> & WynBIOption & commonConfig

DashboardDesignerDefaults

Ƭ DashboardDesignerDefaults: Object

The default properties of DashboardDesignerInitOption.

Type declaration

clickAction?: string

The dashboard click actions.

containerFilterScope?: string

The dashboard container filter scope.

contextMenuActions?: string

The dashboard context menu actions.

dashboardId?: string

The dashboard ID.

datasetId?: string

The dashboard dataset ID.

dbdTemplateId?: string

The id of dashboard created with dashboard template.

documentThemeId?: string

The dashboard document theme ID.

dp?: object | string

The dashboard parameters.

enableDeveloperMode?: boolean

Enable developer mode for custom visual dev tools.

lng?: string

The language of the user interface.

notificationTime?: number

The setting for dashboard notification time.

templateId?: string

The template ID to create a dashboard document.

theme?: string

The dashboard theme.

DashboardDesignerFeatures

Ƭ DashboardDesignerFeatures: Object

The features and properties of DashboardDesignerInitOption.

Type declaration

actionbarItems?: string[]

Define the action bar's action white list.

componentCategories?: string[]

Control which component categories are available in the designer.

disableAnimation?: boolean

Control the animation enabled.

disableChangeDataset?: boolean

Control whether the user can change the binding dataset of the scenario.

showCloseButton?: boolean

Control the visibility of the close button.

showDataBindingPanel?: boolean

Control the visibility of the designer's data binding panel.

showHelpButton?: boolean

Control the visibility of the help button.

showInspector?: boolean

Control the visibility of the designer inspector.

showInspectorWhenOpen?: boolean

Control the visibility of the inspector when it is open.

showMobileDesigner?: boolean

Control the visibility of the mobile designer.

showPanelWhenOpen?: boolean

Control the visibility of the panel when it is open.

showWizard?: boolean

Control the visibility of the wizard.

toolbar?: "show" | "hide"

Control the visibility of the toolbar.

DashboardDesignerInitOption

Ƭ DashboardDesignerInitOption: Object

The options for initializing a dashboard designer.

Type declaration

container?: Element

A DOM element used to mount the dashboard designer.

defaults?: DashboardDesignerDefaults

Default options for initializing a dashboard designer.

features?: DashboardDesignerFeatures

Features options for initializing a dashboard designer.

onClose?: () => void

This is a callback function; it will be invoked when the designer is closed.

onError?: (errorInfo: object) => void

This is a callback function that will be invoked when the document has any error messages.

onLoaded?: (docName: string) => void

This is a callback function; it will be invoked after the designer is loaded.

onMount?: () => void

This is a callback function; it will be invoked after the designer is mounted.

onSave?: (docName: string, id: string) => void

This is a callback function that will be invoked when users save a document.

DashboardLiteViewerConfig

Ƭ DashboardLiteViewerConfig: DashboardLiteViewerInitOption & Partial<DashboardLiteViewerDefaults> & WynBIOption & commonConfig

DashboardLiteViewerDefaults

Ƭ DashboardLiteViewerDefaults: Object

The default properties of DashboardLiteViewerInitOptions.

Type declaration

clickAction?: string

The dashboard click actions.

containerFilterScope?: string

The dashboard container filter scope.

contextMenuActions?: string

The dashboard context menu actions.

dashboardId: string

The dashboard ID.

documentThemeId?: string

The dashboard document theme ID.

dp?: object | string

The dashboard parameters.

hideErrors?: boolean

Hide all dashboard error notifications.

lng?: string

The language of the user interface.

notificationTime?: number

The setting of the dashboard notification time.

pageNumber?: string

The viewer page number starts from 1.

scenario?: string

The single scenario name.

showScenarioTitle?: boolean

Allow showing the scenario title only when doing single scenario integration.

theme?: string

The dashboard theme.

DashboardLiteViewerFeatures

Ƭ DashboardLiteViewerFeatures: Object

The features and properties of DashboardLiteViewerInitOptions.

Type declaration

actionbarItems?: string[]

Define the action bar's action white list.

disableAnimation?: boolean

Control the animation enabled.

disableAutoScroll?: boolean

Control the autoscroll enabled.

disableAutoSwitchPage?: boolean

Control the auto-switch page enabled.

DashboardLiteViewerInitOption

Ƭ DashboardLiteViewerInitOption: Object

The options for initializing a dashboard lite viewer.

Type declaration

container?: Element

A DOM element used to mount the dashboard lite viewer.

defaults?: DashboardViewerDefaults

Default options for initializing a dashboard lite viewer.

features?: DashboardViewerFeatures

Features options for initializing a dashboard lite viewer.

manual?: boolean

Disable auto connection to the UIDashboard.

DashboardViewerConfig

Ƭ DashboardViewerConfig: DashboardViewerInitOption & Partial<DashboardViewerDefaults> & WynBIOption & commonConfig

DashboardViewerDefaults

Ƭ DashboardViewerDefaults: Object

The default properties of DashboardViewerInitOptions.

Type declaration

clickAction?: string

The dashboard click actions.

containerFilterScope?: string

The dashboard container filter scope.

contextMenuActions?: string

The dashboard context menu actions.

dashboardId: string

The dashboard ID.

documentThemeId?: string

The dashboard document theme id.

dp?: object | string

The dashboard parameters.

hideErrors?: boolean

Hide all dashboard error notifications.

lng?: string

The language of the user interface.

notificationTime?: number

The setting of dashboard notification time.

pageNumber?: string

The viewer page number starts from 1.

scenario?: string

The single scenario name.

showScenarioTitle?: boolean

Show scenario title only when doing single scenario integration.

size?: "fitheight" | "fittoheight" | "fitwidth" | "fittowidth" | "fitscreen" | "fittoscreen" | "auto"

Set the display mode of the dashboard in the viewer.

theme?: string

The dashboard theme.

DashboardViewerFeatures

Ƭ DashboardViewerFeatures: Object

The features and properties of DashboardViewerInitOptions.

Type declaration

actionbarItems?: string[]

Define the action bar's action white list.

disableAnimation?: boolean

Control the animation enabled.

disableAutoScroll?: boolean

Control the autoscroll enabled.

disableAutoSwitchPage?: boolean

Control the auto switch page enabled.

hideToolbarActions?: boolean

Control the hidden toolbar action items.

DashboardViewerInitOption

Ƭ DashboardViewerInitOption: Object

The options for initializing a dashboard standard viewer.

Type declaration

container?: Element

A DOM element used to mount the dashboard standard viewer.

defaults?: DashboardViewerDefaults

Default options for initializing a dashboard standard viewer.

features?: DashboardViewerFeatures

Features options for initializing a dashboard standard viewer.

onClose?: () => void

Invoked when the designer is closed.

onError?: (errorInfo: object) => void

Invoked when the document has any error messages.

onLoaded?: (docName: string, id: string) => void

Invoked after the designer loaded.

onMount?: () => void

Invoked after the designer mounted.

onRendered?: (docName: string) => void

Invoked after the designer rendered.

DocumentSaveOption

Ƭ DocumentSaveOption: Object

The options of saving the current document.

Type declaration

categories?: string[]

Specify categories for the current document.

comment?: string

Add a comment to the current document.

name?: string

Specify a name for the current document.

shouldPublish?: boolean

Publish the current document when the server enables the draft function.

DocumentSyncOption

Ƭ DocumentSyncOption: Object

The options for synchronizing the state change or not.

Type declaration

syncChanges?: boolean

If there are some state changes in the preview, the designer will show the sync dialog. Use this parameter to synchronize changes to the current document and to control the visibility of the sync dialog.

DrillDownCommandPayload

Ƭ DrillDownCommandPayload: Object

The payload of executing 'DrillDown' command.

Type declaration

drillDimension?: string

The name of a target dimension. Available only when the drill type is All or List; if the drill type is Path, the drillDimension is ignored and drill to the dimension specified at data binding.

target: string

The name of a scenario that you want to control.

DrillResetCommandPayload

Ƭ DrillResetCommandPayload: Object

The payload of executing 'ResetDrill' command.

Type declaration

target: string

The name of a scenario that you want to control.

DrillUpCommandPayload

Ƭ DrillUpCommandPayload: Object

The payload of executing 'DrillUp' command.

Type declaration

target: string

The name of a scenario that you want to control.

HideScenarioCommandPayload

Ƭ HideScenarioCommandPayload: Object

The payload of executing 'HideScenario' command.

Type declaration

delay?: number

The delay time(s) for executing the command.

duration?: number

The duration time(s) of showing or hiding a scenario.

leaveAnimation?: "none" | "top" | "bottom" | "left" | "right" | "fadeIn"

The animation type of hiding a scenario.

scenarioId?: string

The ID of a scenario.

target: string

The name of a scenario that you want to control.

SceneConfig

Ƭ SceneConfig: Object

The options of initializing a dashboard designer.

Type declaration

docId?: string

The scene id.

documentThemeId?: string

The scene theme id.

lng?: string

The language of the user interface.

theme?: string

The scene theme.

SceneDesignerConfig

Ƭ SceneDesignerConfig: SceneDesignerInitOption & SceneConfig & WynBIOption & commonConfig

SceneDesignerInitOption

Ƭ SceneDesignerInitOption: Object

Type declaration

container?: Element

A DOM element used to mount the scene designer.

onClose?: () => void

Invoked when the designer is closed.

onError?: (errorInfo: object) => void

Invoked when the document has any error message.

onLoaded?: (docName: string, id: string) => void

Invoked after the designer loaded.

onMount?: () => void

Invoked after the designer mounted.

onSave?: (id: string) => void

This is a callback function, it will be invoked when users save a document.

SceneViewerConfig

Ƭ SceneViewerConfig: SceneViewerInitOption & SceneConfig & WynBIOption & commonConfig

SceneViewerInitOption

Ƭ SceneViewerInitOption: Object

Type declaration

container?: Element

A DOM element used to mount the scene viewer.

onClose?: () => void

Invoked when the viewer is closed.

onError?: (errorInfo: object) => void

Invoked when the document has any error message.

onLoaded?: (docName: string, id: string) => void

Invoked after the viewer is loaded.

onMount?: () => void

Invoked after the viewer is mounted.

onRendered?: (docName: string) => void

Invoked after the viewer is rendered.

ShowScenarioCommandPayload

Ƭ ShowScenarioCommandPayload: Object

The payload of executing 'ShowScenario' command.

Type declaration

delay?: number

The delay time(s) for executing the command.

duration?: number

The duration time(s) of showing or hiding a scenario.

enterAnimation?: "none" | "top" | "bottom" | "left" | "right" | "fadeIn"

The animation type of showing a scenario.

scenarioId?: string

The ID of a scenario.

target: string

The name of a scenario that you want to control.

SwitchPageCommandPayload

Ƭ SwitchPageCommandPayload: Object

The payload of executing 'SwitchPage' command.

Type declaration

index?: number

The index of the page.

name?: string

The name of the page.

pageId?: string

The id of the page.

SwitchTabCommandPayload

Ƭ SwitchTabCommandPayload: Object

The payload of executing 'SwitchTab' command.

Type declaration

containerId?: string

The ID of the container.

index?: number

The index of a tab of the container.

name?: string

The name of a tab of the container.

target: string

The name of the container that you want to control.

ToggleScenarioCommandPayload

Ƭ ToggleScenarioCommandPayload: Object

The payload of executing 'ToggleScenario' command.

Type declaration

delay?: number

The delay time(s) for executing the command.

duration?: number

The duration time(s) of showing or hiding a scenario.

enterAnimation?: "none" | "top" | "bottom" | "left" | "right" | "fadeIn"

The animation type of showing a scenario.

leaveAnimation?: "none" | "top" | "bottom" | "left" | "right" | "fadeIn"

The animation type of hiding a scenario.

scenarioId?: string

The ID of a scenario.

target: string

The name of a scenario that you want to control.

WynBIOption

Ƭ WynBIOption: Object

The basic option to create a WynBI instance.

Type declaration

| Name | Type |

baseUrl: string

The web address of your Wyn server.

token: string

The access token that is generated from the Admin portal.

tokenKey?: string

Set the key name used in query parameters, this name is configured in the Wyn config file.

If tokenKey is not specified, the default value 'token' is used.

Example

tokenKey: 'tkn'

WynDashboardApp

Ƭ WynDashboardApp<T>: T extends "DashboardDesigner" ? DashboardDesigner : T extends "DashboardViewer" ? DashboardViewer : T extends "ViewerLite" ? DashboardLiteViewer : any

Type parameters

WynDashboardAppType

Ƭ WynDashboardAppType: "DashboardDesigner" | "DashboardViewer" | "ViewerLite" | "SceneDesigner" | "SceneViewer"

commonConfig

Ƭ commonConfig: Object

Type declaration

version?: string