[]
        
(Showing Draft Content)

dashboard.WynVisual

类: WynVisual

dashboard.WynVisual

用户创建自定义可视化插件时应实现的主类。

Table of contents

构造方法

属性

方法

构造方法

constructor

new WynVisual(dom, host, updateOptions)

参数

名称 类型 描述
dom HTMLDivElement 当前可视化插件渲染在这个dom下。
host VisualHost 为用户提供一些控制当前可视化插件的服务。
updateOptions IVisualUpdateOptions 提供一些文档信息供用户使用。

属性

Enums

Static Enums: WynVisualEnums

为用户提供一些枚举类型。


Models

Static Models: WynVisualModels

为用户提供一些模型,目前主要是筛选器。

方法

export

export(format): Promise<string>

当您需要导出图片或svg时实现。 该方法一般在渲染完成之后调用,需要先调用eventService的renderFinish方法通知文档实例已渲染完成。

参数

名称 类型
format ExportFormat

返回值

Promise<string>


getActionBarHiddenState

getActionBarHiddenState(updateOptions): string[]

返回一个操作列表,这些操作将不在属性面板上显示。

参数

名称 类型 描述
updateOptions IVisualUpdateOptions 提供一些文档信息供用户使用。

返回值

string[]


getColorAssignmentConfigMapping

getColorAssignmentConfigMapping(dataViews): IColorAssignmentConfigMapping

返回一个颜色赋值映射对象,表示为哪个值分配颜色。

参数

名称 类型 描述
dataViews IDataView[] 在 capabilities.json 中定义的计算数据视图。(dataViewMapping)

返回值

IColorAssignmentConfigMapping

示例代码

public getColorAssignmentConfigMapping(dataViews: VisualNS.IDataView[]): VisualNS.IColorAssignmentConfigMapping {
	if (!dataViews.length) {
 	return null;
	}
	const plain = dataViews[0].plain;
	const colorProfile = plain.profile.series.values[0];
	if (!colorProfile) {
		return null;
	}

	const colorValues = plain.data.map(d => d[colorProfile.display]);
 return {
		mainColorAssignment: {
			values: Array.from(new Set(colorValues)),
			type: 'dimension',
			columns: [colorProfile],
		},
	};
}

getInspectorHiddenState

getInspectorHiddenState(updateOptions): string[]

返回一个属性列表,这些属性将不在属性面板上显示。

参数

名称 类型 描述
updateOptions IVisualUpdateOptions 提供一些文档信息供用户使用。

返回值

string[]


onDestroy

onDestroy(): void

当前实例卸载时调用。

返回值

void


update

update(options): void

当聚合或属性发生任何变化时调用。

参数

名称 类型 描述
options IVisualUpdateOptions 提供一些文档信息供用户使用。

返回值

void