[]
        
(Showing Draft Content)

dashboard.DashboardViewer

类: DashboardViewer

dashboard.DashboardViewer

Table of contents

构造方法

方法

构造方法

constructor

new DashboardViewer()

方法

destroy

destroy(): void

释放仪表板高级查看器实例的资源

返回值

void


executeCommand

executeCommand(option): Promise<void>

执行仪表板命令

参数

名称 类型
option CommandOption

返回值

Promise<void>

示例代码

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

getDatasets

getDatasets(): Promise<any[]>

获取所有使用的数据集

返回值

Promise<any[]>


initialize

initialize(initOption): Promise<void>

初始化仪表板高级查看器

参数

名称 类型
initOption DashboardViewerInitOption

返回值

Promise<void>

示例代码

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

requestFullScreen

requestFullScreen(): void

切换到全屏模式

返回值

void


setParameterValue

setParameterValue(parameters): void

设置仪表板的默认参数值

参数

名称 类型
parameters Object

返回值

void

示例代码

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