Requires

• module:ht-overview.js

Methods

addListeners() → {void}

添加监听

Returns:

void

addPropertyChangeListener(listener, scope, ahead) → {void}

增加自身属性变化事件监听器

Parameters:

Name	Type	Attributes	Description
listener	function		监听器函数
scope	any	<optional>	监听器函数域
ahead	boolean	<optional>	是否将当前监听器插入到监听器列表开头

Returns:

void

addToDOM(parentNode) → {void}

将视图插入到 dom 中

Parameters:

Name	Type	Attributes	Description
parentNode	HTMLDivElement	<optional>	父DOM

Returns:

void

addViewListener(listener, scope, ahead) → {void}

监听视图事件，如布局、刷新等

Parameters:

Name	Type	Attributes	Description
listener	function		监听器函数
scope	object	<optional>	监听器函数域
ahead	boolean	<optional>	是否将当前监听器插入到监听器列表开头

Returns:

void

center(pointOrEvent) → {void}

传入逻辑坐标点或者交互 event 事件参数，移动中心的为当前点

Parameters:

Name	Type	Description
pointOrEvent	object | Event

Returns:

void

dispose() → {void}

销毁此组件

Returns:

void

firePropertyChange(property, oldValue, newValue, equalFunc, params) → {void}

派发属性变化事件，可使用fp的简写方式

Parameters:

Name	Type	Attributes	Description
property	string		属性
oldValue	any		旧值
newValue	any		新值
equalFunc	function	<optional>	相等判断函数
params	any	<optional>	其它参数

Returns:

void

See:

• fp

fireViewEvent(kind) → {void}

Parameters:

Name	Type	Description
kind	string

Returns:

void

fp(property, oldValue, newValue, equalFunc, params) → {void}

派发属性变化事件

Parameters:

Name	Type	Attributes	Description
property	string		属性
oldValue	any		旧值
newValue	any		新值
equalFunc	function	<optional>	相等判断函数
params	any	<optional>	其它参数

Returns:

void

See:

• firePropertyChange

getCanvas() → {HTMLCanvasElement}

获取拓扑的画布

Returns:

HTMLCanvasElement -

画布

getClass() → {function}

获取类声明(构造函数)

Returns:

function -

类声明(构造函数)

getClassName() → {string}

获取类全名

Returns:

string -

类全名

getContentBackground() → {string}

获取内容背景颜色

Returns:

string -

内容背景颜色

getDisabledDiv() → {HTMLElement}

获取被禁用组件的div

Returns:

HTMLElement -

被禁用组件的div

getFixToRect() → {boolean|object}

获取指定绘制的矩形区域

Returns:

boolean | object -

指定绘制的矩形区域

getGraphView() → {ht.graph.GraphView}

获取显示的拓扑组件

Returns:

ht.graph.GraphView -

显示的拓扑组件

getHeight() → {number}

获取布局高度

Returns:

number -

布局高度

getMask() → {HTMLCanvasElement}

获取显示可见区域的 dom 节点

Returns:

HTMLCanvasElement -

显示可见区域的 dom 节点

getMaskBackground() → {string}

获取显示可见区域的背景颜色

Returns:

string -

显示可见区域的背景颜色

getSuperClass() → {function}

获取父类声明(构造函数)

Returns:

function -

父类声明(构造函数)

getView() → {HTMLDivElement}

获取组件的根层div

Returns:

HTMLDivElement

getWidth() → {number}

获取布局宽度

Returns:

number -

布局宽度

handle_DOMMouseScroll(e) → {void}

Parameters:

Name	Type	Description
e	Event

Returns:

void

handle_mousedown(e) → {void}

Parameters:

Name	Type	Description
e	Event

Returns:

void

handle_mousewheel(e) → {void}

Parameters:

Name	Type	Description
e	Event

Returns:

void

handle_touchstart(e) → {void}

Parameters:

Name	Type	Description
e	Event

Returns:

void

handleGraphViewChanged(obj) → {void}

处理 graphView 变化，可重载交互

Parameters:

Name	Type	Description
obj	object

Returns:

void

handleGraphViewPropertyChanged(obj) → {void}

处理 graphView 属性变化，可重载交互

Parameters:

Name	Type	Description
obj	object

Returns:

void

handleScroll(e, delta) → {void}

处理鼠标滚轮缩放，可重载重新定义缩放逻辑，一般用于禁用缩放

Parameters:

Name	Type	Description
e	Event	鼠标滚轮事件
delta	number	滚轮增量

Returns:

void

handleWindowMouseMove(e) → {void}

Parameters:

Name	Type	Description
e	Event

Returns:

void

handleWindowMouseUp(e) → {void}

Parameters:

Name	Type	Description
e	Event

Returns:

void

handleWindowTouchEnd(e) → {void}

Parameters:

Name	Type	Description
e	Event

Returns:

void

handleWindowTouchMove(e) → {void}

Parameters:

Name	Type	Description
e	Event

Returns:

void

invalidate(delay) → {void}

无效组件，并调用延时刷新

Parameters:

Name	Type	Description
delay	number	延迟刷新的间隔事件(单位:ms)

Returns:

void

See:

• iv

isAutoUpdate() → {boolean}

获取组件是否跟随拓扑刷新

Returns:

boolean -

组件是否跟随拓扑刷新

isDisabled() → {boolean}

组件是否处于不可用状态，处于此状态时不能进行任何操作并且会遮挡一层蒙板

Returns:

boolean

iv(delay) → {void}

无效组件，并调用延时刷新

Parameters:

Name	Type	Attributes	Description
delay	number	<optional>	延迟刷新的间隔事件(单位:ms)

Returns:

void

See:

• invalidate

layout(x, y, width, height) → {void}

执行布局

Parameters:

Name	Type	Description
x	number	视图左上角布局 x 点位置
y	number	视图左上角布局 y 点位置
width	number	视图宽度
height	number	视图高度

Returns:

void

mp(listener, scope, ahead) → {void}

增加自身属性变化事件监听器，addPropertyChangeListener 的缩写

Parameters:

Name	Type	Attributes	Description
listener	function		监听器函数
scope	any	<optional>	监听器函数域
ahead	boolean	<optional>	是否将当前监听器插入到监听器列表开头

Returns:

void

See:

• addPropertyChangeListener

onPropertyChanged(event) → {void}

属性变化回调函数，可重载做后续处理

Parameters:

Name	Type	Description
event	object	属性变化事件

Returns:

void

Example

//event格式：
{
	property: 'name',//发生变化的属性
	oldValue: 'oldValue',//旧值
	newValue: 'newValue',''新值
	data: data//发生变化的data
}

redraw() → {void}

重绘

Returns:

void

removeListeners() → {void}

移除监听

Returns:

void

removePropertyChangeListener(listener, scope) → {void}

删除自身属性变化事件监听器

Parameters:

Name	Type	Attributes	Description
listener	function		监听器函数
scope	object	<optional>	监听器函数域

Returns:

void

removeViewListener(listener, scope) → {void}

删除视图事件监听器

Parameters:

Name	Type	Attributes	Description
listener	function		监听器函数
scope	object	<optional>	监听器函数域

Returns:

void

setAutoUpdate(auto) → {void}

设置组件是否跟随拓扑刷新

Parameters:

Name	Type	Description
auto	boolean

Returns:

void

setContentBackground(contentBackground) → {void}

设置内容区域背景颜色

Parameters:

Name	Type	Description
contentBackground	string	内容区域背景颜色

Returns:

void

setContentBorderColor(borderColor) → {void}

设置内容区域边框颜色

Parameters:

Name	Type	Description
borderColor	string	内容区域边框颜色

Returns:

void

setCursor(style) → {void}

设置 css 的鼠标样式，cursor

Parameters:

Name	Type	Description
style	string	css 的鼠标样式

Returns:

void

setDisabled(value, iconUrl) → {void}

设置组件是否处于不可用状态，处于不可用状态时不能进行任何操作并且会遮挡一层蒙板

Parameters:

Name	Type	Attributes	Description
value	boolean		是否禁用组件
iconUrl	string	<optional>	蒙板上显示的icon的路径

Returns:

void

setFixToRect(fixToRect) → {void}

设置指定绘制的矩形区域，如果传入 true 则默认绘制 getContentRect， 传入对象格式 {x,y,width,height}

Parameters:

Name	Type	Description
fixToRect	boolean | object

Returns:

void

setFocus(value) → {void}

根据值给组件设置焦点

Parameters:

Name	Type	Attributes	Description
value	string	<optional>

Returns:

void

setGraphView(view) → {void}

设置显示的拓扑

Parameters:

Name	Type	Description
view	ht.graph.GraphView	拓扑组件

Returns:

void

setHeight(height) → {void}

设置布局高度

Parameters:

Name	Type	Description
height	number	高度值

Returns:

void

setMaskBackground(color) → {void}

设置显示可见区域的背景颜色

Parameters:

Name	Type	Description
color	string	显示可见区域的背景颜色

Returns:

void

setWidth(width) → {void}

设置布局宽度

Parameters:

Name	Type	Description
width	number	宽度值

Returns:

void

ump(listener, scope) → {void}

删除自身属性变化事件监听器，removePropertyChangeListener的缩写

Parameters:

Name	Type	Attributes	Description
listener	function		监听器函数
scope	object	<optional>	监听器函数域

Returns:

void

See:

• removePropertyChangeListener

validate() → {void}

立刻刷新拓扑

Returns:

void

validateImpl() → {void}

刷新

Returns:

void