Class: PlottingSymbol

csplotting~ PlottingSymbol


<abstract> new PlottingSymbol(options)

标绘符号的基类
Parameters:
Name Type Description
options Object
Properties
Name Type Argument Description
libID Number 标绘符号的库号
code Number 标绘符号的代号
pickId * <optional>
鼠标选中当前标绘符号时返回的对象

Extends

Methods


getPlottingLayer()

获取标绘图层

setPlottingLayer(plottingLayer)

设置标绘图层
Parameters:
Name Type Description
plottingLayer * 标绘图层

getLibID()

获取标绘符号的库号

getCode()

获取标绘符号的代号

bind(symbol)

绑定二维标绘,一旦绑定之后,调用三维标绘的相关接口时,二维标绘会同步改变
Parameters:
Name Type Description
symbol * 标绘符号
See:

unbind()

解除绑定二维标绘
See:

getUuid()

获取标绘符号的唯一标识(UUID)

getPickId()

鼠标选取到当前标绘符号时返回的对象

getVisible()

获取标绘符号的显示隐藏状态

setVisible(value)

设置标绘符号的显示隐藏状态
Parameters:
Name Type Description
value Boolean 标绘符号的显隐状态

获取标绘符号闪烁的状态

设置标绘符号是否闪烁
Parameters:
Name Type Description
value Boolean 标绘符号闪烁状态

getPickable()

获取标绘符号是否可以被选中

setPickable(value)

设置标绘符号是否可以被选中
Parameters:
Name Type Description
value Boolean 是否可以被选中

getCustom()

获取用户自定义对象

setCustom(customObj)

设置用户自定义对象
Parameters:
Name Type Description
customObj * 用户自定义对象

toJson()

导出为json字符串

<abstract, static> fromJson()


<abstract, static> copy()


destroy()

销毁标绘符号
Overrides:

dispatchEvent(event)

发送事件消息,每个事件消息都有类型(type),所有监听此对象对应类型事件的监听者都会接收到相应的事件消息
Parameters:
Name Type Description
event string | module:events.Event 事件对象
Inherited From:
Overrides:

on(type, listener [, opt_this])

指定监听器监听指定类型的事件
Parameters:
Name Type Argument Default Description
type string 事件类型
listener callback | function 监听器
opt_this Object <optional>
target 在监听器中的`this`所指示的对象,默认是`target`自身
Inherited From:
Overrides:
Returns:
监听器的唯一标识.
Type
Object

once(type, listener [, opt_this])

指定监听器只监听一次指定类型的事件
Parameters:
Name Type Argument Default Description
type string 事件类型
listener callback | function 监听器
opt_this Object <optional>
target 在监听器中的`this`所指示的对象,默认是`target`自身
Inherited From:
Overrides:
Returns:
监听器的唯一标识.
Type
Object

un(type, listener [, opt_this])

取消指定监听器监听指定类型的事件
Parameters:
Name Type Argument Default Description
type string 事件类型
listener callback | function 监听器
opt_this Object <optional>
target 在监听器中的`this`所指示的对象,默认是`target`自身
Inherited From:
Overrides:

unByKey(key)

根据监听器的唯一标识取消指定监听器监听事件,监听器的唯一标识通过`on()`或者`once()`返回得到
Parameters:
Name Type Description
key Object | Array.<Object> 监听器的唯一标识,通过`on()`或者`once()`返回得到,可以是多个监听器的唯一标识数组
Inherited From:
Overrides: