renderStart

renderStart(): void

用于通知仪表板该组件的渲染状态

// Update method will be invoke while something changed.

public update(options: VisualNS.IVisualUpdateOptions) {

this.visualHost.eventService.renderStart();

try {

this.render(); // render method is used to update UI

this.visualHost.eventService.renderFinish();

} catch (e) {

this.visualHost.eventService.renderError();

}

}

renderError

renderError(): void

renderFinish

renderFinish(): void

registerOnCustomEventCallback

registerOnCustomEventCallback(fn: (name: string) => void)

用于注册操作栏事件

callback 是自定义事件处理程序

// Register the callback in visual constructor. It will print the action name when you click the corresponding button on action bar.

this.visualHost.eventService.registerOnCustomEventCallback((name: string) => {

console.log(name);

});

getDisplay

getDisplay(displayNameKey: string): string

返回本地化字符串

const noDataText = this.visualHost.localizationManager.getDisplay('NoData');

this.container.textContent = noDataText;

show

interface ITootipPosition {

x: number;

y: number;

}

interface ILabelFields {

label: string;

value: string;

}

interface ITooltipConfig {

position: ITootipPosition;

title?: string;

fields?: ILabelFields[];

selectionId?: SelectionId;

selected?: SelectionId[];

menu?: boolean;

}

show(config: VisualImplNS.ITooltipConfig): void

显示提示（tooltip）

- position: 鼠标光标位置

- title: 提示的标题

- fields: 需要显示在提示信息中的字段

- selectionId：显示字段的另一种方式，提示信息将显示您绑定到selectionId的字段

- selected: 所有选择的 selectionId

- menu：应在提示上显示菜单，例如向下钻取，保留和排除。

// this function will bind to the chart mouse enter event. It will show a tooltip with title, fields, selection info and menu buttons.

private mouseEnterHandler = (node: any) => {

this.visualHost.toolTipService.show({

position: {

x: d3.event.x,

y: d3.event.y,

},

title: node.data.color,

fields: [{

label: this.valueField,

value: node.data.value,

}],

selectionId: node.data.selectionId,

selected: this.selectionManager.getSelectionIds(),

menu: true,

});

}

hide

hide(): void

隐藏提示（tooltip）

// hide the tooltip when the mouse leave the chart shape

private mouseLeaveHandler = () => {

this.visualHost.toolTipService.hide();

}

move

move(pos: VisualImplNS.ITootipPosition): void

移动提示（tooltip）

// update the tooltip position while mouse move on chart

private mouseMoveHandler = (e: any) => {

this.visualHost.toolTipService.move({

x: d3.event.x,

y: d3.event.y,

});

}

setProperty

setProperty(propertyName: string, value: any): void

更新属性

// when the button be clicked. The property of showBorder will be change.

private onToggle = () => {

this.visualHost.propertyService.setProperty('showBorder', !this.properties.showBorder);

}

isAutoDisplayUnit

isAutoDisplayUnit(displayUnit: DisplayUnit): boolean

判断 displayUnit 是否为DisplayUnit.Auto

enum DisplayUnit {

Auto = 'auto',

None = 'none',

Hundreds = 'hundreds',

Thousands = 'thousands',

TenThousand = 'tenThousands',

HundredThousand = 'hundredThousand',

Millions = 'millions',

TenMillion = 'tenMillion',

HundredMillion = 'hundredMillion',

Billions = 'billions',

Trillions = 'trillions',

}

getAutoDisplayUnit

getAutoDisplayUnit(values: number[]): DisplayUnit

当displayUnit为DisplayUnit.Auto时，得到realDisplayUnit。

format

format(format: string, value: number): string

格式化数值。

第一个参数格式来自 Format Property或 DataView Profile 项目。

默认 displayUnit 为 DisplayUnit.None;

const formatService = this.visualHost.formatService;

const { displayUnit, labelFormat } = updateOptions.properties;

let realDisplayUnit = displayUnit;

if (formatService.isAutoDisplayUnit(displayUnit)) {

const values = dataPoints.map(dataPoint => dataPoint.value);

realDisplayUnit = formatService.getAutoDisplayUnit(values);

}

dataPoints.forEach((dataPoint) => {

// prepare a formated text for label.

dataPoint.labelText = formatService.format(labelFormat, dataPoint.value, realDisplayUnit);

})

createSelectionManager

createSelectionManager(): SelectionManager

创建一个SelectionManager。

this.selectionManager = this.visualHost.selectionService.createSelectionManager();

createSelectionId

createSelectionId(): SelectionId

为数据点创建SelectionId。

const selectionId = this.visualHost.selectionService.createSelectionId();

withMeasure

withMeasure(profile: RuntimeNS.IFieldProfile, dataPoint?: RuntimeNS.IDataPoint): SelectionId

将度量字段绑定到selection id。

public update(options: VisualNS.IVisualUpdateOptions) {

console.log(options);

const dataView = options.dataViews[0];

// convert the data view to datas which can be used in chart

if (dataView) {

const plainData = dataView.plain;

// get the fields via different data role.

const valueField = plainData.profile.values.values[0].display;

const sizeField = plainData.profile.series.values[0].display;

const colorField = plainData.profile.dimensions.values[0].display;

const items = plainData.data.reduce((result: any, item: any, i: number) => {

if (item[valueField]) {

// create a selection id for a data point.

const selectionId = this.visualHost.selectionService.createSelectionId();

// set the dimensions of the selection id. This will affect on the crossfilter result and others.

selectionId

.withDimension(plainData.profile.dimensions.values[0], item)

.withDimension(plainData.profile.series.values[0], item)

.withMeasure(plainData.profile.tooltip.values[0], item)

// attach the selection id on data model. so that you can access it on hit test

result.push({

size: (item[sizeField] || '-') + '',

value: item[valueField],

color: (item[colorField] || '') + '',

id: i,

selectionId,

});

}

return result;

}, []);

// refresh the chart with new data items

this.render(items);

}

};

withDimension

withDimension(profile: RuntimeNS.IFieldProfile, dataPoint: RuntimeNS.IDataPoint): SelectionId

将维度字段绑定到selection id。

setSelectionIds

setSelectionIds(ids: Array<SelectionId>)

setter

getSelectionIds

getSelectionIds(): Array<SelectionId>

getter

getCount

getCount(): number

获取所选selectionId的计数

select

select(id: SelectionId

Array<SelectionId>, multiSelect: boolean = false): Promise<void>

选择一个或多个selectionId。multiselect表示应该支持选择多个selectionId。它返回一个许可，并将在选择完成后解决。

clear

clear(id?: SelectionId): Promise<void>

清除选中的或者全部 SelectionId。

registerOnSelectCallback

registerOnSelectCallback(onSelectCallback: (ids: SelectionId[]) => void)

Register a callback, the callback will be invoke after every selection change.

注册 callback，每次选择更改后都将调用callback。

this.selectionManager.registerOnSelectCallback(() => {

// while the selection state changed, should update ui, to highlight the shape which has been selected

this.render();

});

contains

contains(id: SelectionId): boolean

检查目标id 是否被选中。

isEmpty

isEmpty(): boolean

检查 selection manager 是否包含选中的selectionId。

get

get(key: string): string

获取配置项

// to access the amapToken in configuration

const amapToken = this.visualHost.configurationManager.get('amapToken');

getImage

getImage(imageName: string): string

返回base64字符串

// to access the image in assets

this.container.style.backgroundImage = url(${host.assetsManager.getImage('testImg')});

execute

interface ICommandDescription {

name: string;

payload: {

target: string;

};

}

execute(commandsDesc: Array<ICommandDescription>): void

执行命令

// run a command to active a tab container

this.visualHost.commandService.execute([{

name: 'SelectTab',

payload: {

target: 'myTabContainer',

index: 0,

}

}])

SwitchTab

用户可以使用这个命令来切换选项卡组件中的标签。

- SwitchTab 命令是专为选项卡设计的命令。

- 标签的索引将通过参数命令传递。

以下是 SwitchTab 的接口。

- 如果 index 小于0，将切换到0；如果 index 大于标签计数-1，将切换到最后一个标签。

- 如存在多个标签时，建议使用选项卡的组件名称来定位标签。

- 如果 index 和组件名称同时被传递，则 index 优先生效。

- 在Visual Plugin中使用 command service 来调用SwitchTab命令。

- 在命令被立即执行后，选项卡标签将显示为预期的样子。

- 如果执行失败，返回值将是 false，否则是 true。

SwitchPage

用户可以使用这个命令来切换仪表板页面。

- SwitchPage 命令是专仪表板设计的。

- 如果 page index 或 page name 无效，将不进行页面切换。

- 如果存在大量的页面，page index 就很难计算。建议使用页面名称（page name）。

- 如果page index 和 page name 同时被传递，那么page index 优先生效。

- 在Visual Plugin 中使用command service 来调用SwitchPage命令。

- 在命令被立即执行后，页面切换将显示为预期的效果。

Keep/Exclude

用户可以使用这个命令来执行保留或排除操作。

// Keep & Exclude

this.host.commandService.execute([{

name: 'Keep', // or 'Exclude'

payload: {

selectionIds,

},

}]);

—

Drill/Jump

用户可以使用这个命令来执行钻取或跳转操作。

// Drill & Jump

this.host.commandService.execute([{

name: 'Drill', // or 'Jump'

payload: {

selectionIds, // optional

position: { x: event.clientX, y: event.clientY },

},

}]);

—

ShowScenario

显示一个组件

this.host.commandService.execute([{

name: 'ShowScenario',

payload: {

scenarioId: string;

target: string,(optional, target scenario name)

enterAnimation: ScenarioAnimationType,

delay: number;

duration: number;

},

}]);

—

HideScenario

隐藏一个组件

this.host.commandService.execute([{

name: 'HideScenario',

payload: {

scenarioId: string;

target: string,(optional, target scenario name)

enterAnimation: ScenarioAnimationType,

delay: number;

duration: number;

},

}]);

—

ToggleScenario

显示或隐藏组件

this.host.commandService.execute([{

name: 'ToggleScenario',

payload: {

scenarioId: string;

target: string,(optional, target scenario name)

enterAnimation: ScenarioAnimationType,

delay: number;

duration: number;

},

}]);

applyFilter

interface IFilterTarget {

// dataset: string;

column: string;

}

enum VisualFilterType {

Basic = 'basic',

Advanced = 'advanced',

Tuple = 'tuple',

}

interface IFilterBase {

target: IFilterTarget;

filterType: VisualFilterType;

}

applyFilter(filter: BasicFilter | TupleFilter | AdvancedFilter): void

该方法用于调用过滤器。

dom.addEventListener('click', (e) => {

const it = e.target as HTMLLIElement;

if (it.hasAttribute('data-value')) {

const val = it.dataset.value;

if (this.filter.contains(val)) {

this.filter.remove(val);

} else {

this.filter.add(val);

}

host.filterService.applyFilter(this.filter);

} else if (it.getAttribute('data-role') === 'toggle') {

this.filter.setOperator(this.filter.getOperator() === Enums.BasicFilterOperator.In ?

Enums.BasicFilterOperator.NotIn :

Enums.BasicFilterOperator.In

);

host.filterService.applyFilter(this.filter);

}

})

clean

clean(): void

清除过滤器

host.filterService.clean();

constructor

enum BasicFilterOperator {

In = 'In',

NotIn = 'NotIn',

}

interface IBasicFilter extends IFilterBase {

operator: BasicFilterOperator;

values: any[];

}

constructor(targetProfile: RuntimeNS.IFieldProfile, operator: BasicFilterOperator = BasicFilterOperator.In, values: any[] = [])

targetProfile是数据视图中的过滤区域。

const profile = dv.plain.profile.dimensions.values[0];

const BasicFilter = WynVisual.Models.Filter.BasicFilter;

const filter = new BasicFilter(profile);

setOperator/getOperator

setOperator(operator: BasicFilterOperator)

getOperator(): BasicFilterOperator

this.filter.setOperator(this.filter.getOperator() === WynVisual.Enums.BasicFilterOperator.In ?

WynVisual.Enums.BasicFilterOperator.NotIn :

WynVisual.Enums.BasicFilterOperator.In

)

setValues/getValues

getValues(): any[]

setValues(vals: any[])

filter.setValues(['DTD1', 'DTD2'])

toJSON/fromJSON

toJSON(): BasicNS.IBasicFilter

fromJSON(obj: BasicNS.IBasicFilter)

从updateOptions.filters中恢复过滤器。

const profile = dv.plain.profile.dimensions.values[0];

const filter = new BasicFilter(profile);

filter.fromJSON(options.filters[0]);

contains

contains(value: any): boolean

是否包含在过滤器中的值

if (this.filter.contains(val)) {

this.filter.remove(val);

} else {

this.filter.add(val);

}

remove/add

remove(val: any)

add(val: any)

添加或移除值

if (this.filter.contains(val)) {

this.filter.remove(val);

} else {

this.filter.add(val);

}

isEmpty

isEmpty(): boolean

constructor

type ITuple = { value: any }[];

interface ITupleFilter {

target: IFilterTarget[];

filterType: VisualFilterType;

operator: BasicFilterOperator;

values: ITuple[];

}

constructor(targetProfiles: RuntimeNS.IFieldProfile[], operator: BasicFilterOperator = BasicFilterOperator.In, values: BasicNS.ITuple[] = [])

const dimensionsProfiles = dv.plain.profile.dimensions.values;

const filter = new TupleFilter(dimensionsProfiles);

setOperator/getOperator

setOperator(operator: BasicFilterOperator)

getOperator(): BasicFilterOperator

getValues/setValues

getValues(): BasicNS.ITuple[]

setValues(vals: BasicNS.ITuple[])

toJSON/fromJSON

toJSON(): BasicNS.ITupleFilter

fromJSON(obj: BasicNS.ITupleFilter)

contains

contains(tuple: BasicNS.ITuple): boolean

remove/add

remove(tuple: BasicNS.ITuple)

add(tuple: BasicNS.ITuple)

createTuple

createTuple(dp: RuntimeNS.IDataPoint, depth?: number): BasicNS.ITuple

按选定的数据点创建元组

this.items = dv.plain.data.reduce((res, dp) => {

const label = Object.keys(dp).map(key => dp[key]).join('-');

const tuple = filter.createTuple(dp);

res.push({

label,

className: filter.contains(tuple) ? 'selected' : '',

tuple: JSON.stringify(tuple),

});

return res;

}, []);

isEmpty

isEmpty(): boolean

constructor

enum AdvancedFilterLogicalOperator {

And = 'And',

Or = 'Or',

}

enum AdvancedFilterOperator {

LessThan = 'LessThan',

LessThanOrEqual = 'LessThanOrEqual',

GreaterThan = 'GreaterThan',

GreaterThanOrEqual = 'GreaterThanOrEqual',

Contains = 'Contains',

DoesNotContain = 'DoesNotContain',

StartWith = 'StartWith',

DoesNotStartWith = 'DoesNotStartWith',

EndWith = 'EndWith',

DoesNotEndWith = 'DoesNotEndWith',

Is = 'Is',

IsNot = 'IsNot',

}

interface IAdvancedFilterCondition {

value: any;

operator: AdvancedFilterOperator;

caseSensitive?: boolean; // only avaliable while using text compare operator(such as contains/startWith ...)

}

interface IAdvancedFilter extends IFilterBase {

conditions: IAdvancedFilterCondition[];

logicalOperator: AdvancedFilterLogicalOperator;

}

constructor(targetProfile: RuntimeNS.IFieldProfile, logicalOperator: AdvancedFilterLogicalOperator = AdvancedFilterLogicalOperator.And, conditions: BasicNS.IAdvancedFilterCondition[] = [])

setLogicalOperator/getLogicalOperator

setLogicalOperator(operator: AdvancedFilterLogicalOperator)

getLogicalOperator(): AdvancedFilterLogicalOperator

setConditions/getConditions

setConditions(conditions: BasicNS.IAdvancedFilterCondition[])

getConditions(): BasicNS.IAdvancedFilterCondition[]

this.filter.setConditions([{

value: min,

operator: this.includeMinEle.checked ? Enums.AdvancedFilterOperator.GreaterThanOrEqual : Enums.AdvancedFilterOperator.GreaterThan,

}, {

value: max,

operator: this.includeMaxEle.checked ? Enums.AdvancedFilterOperator.LessThanOrEqual : Enums.AdvancedFilterOperator.LessThan,

}]);

toJSON/fromJSON

toJSON(): BasicNS.IAdvancedFilter

fromJSON(obj: BasicNS.IAdvancedFilter)

remove/add

remove(condtion: BasicNS.IAdvancedFilterCondition)

add(condtion: BasicNS.IAdvancedFilterCondition)

isEmpty

isEmpty(): boolean

show

interface IContextMenuConfig {

    position: { x: number, y: number };

}

show: (config: IContextMenuConfig) => void;

show context menu

// show, expect invoke when contextmenu event triggered.

this.host.contextMenuService.show({

    position: { x: e.clientX, y: e.clientY },

});

hide

hide: () => void;

hide context  menu

/*

** hide, when users want to close contextmenu.

** note: after keep/exclude/drill/jump, contextmenu will be closed by default.

*/

this.host.contextMenuService.hide();

getModule

getModule: (name: string) => any;

• 从模块名称获取模块。

• 添加module name visual.json => dependencies. 如：

  • "dependencies": ["echarts"]

• 支持的 modules:

  • echarts

  • lodash

  • html2canvas

const echarts = this.host.moduleManager.getModule('echarts');

const chart = echarts.init(dom);

// other operations

setParameter

`setParameter(pairs: IParameterPair

IParameterPair[]): void;`

设置仪表板静态参数（非绑定类型）值。