Class: Handler

csview~ Handler


<abstract> new Handler(options)

控制器是控制用户与地图交互相关的操作,有各种控制器,比如常用的选择控制器,绘制长方形框控制器,绘制点控制器,绘制线控制器,绘制面控制器等。 用户也可以继承Handler对象,实现自定义的控制器。
Parameters:
Name Type Description
options Object
Properties
Name Type Argument Default Description
hitTolerance Number <optional>
10 处理器在处理地图交互时的像素容差

Extends

Members


enabled

是否启用

Methods


getView()

获取当前控制器的视图对象

getHitTolerance()

获取像素容差

setHitTolerance(value)

设置像素容差
Parameters:
Name Type Description
value Number 像素容差

initialize()

当控制器被添加到视图中时,会调用此方法进行初始化相关的操作。 用户自定义控制器,可以重写initialize方法,处理初始化相关操作。

handleLeftDown()

鼠标左键按下时的控制函数,默认的控制函数什么都没处理,返回true

handleLeftUp()

鼠标左键抬起时的控制函数,默认的控制函数什么都没处理,返回true

handleLeftClick()

鼠标左键单击时的控制函数,默认的控制函数什么都没处理,返回true

handleLeftDoubleClick()

鼠标左键双击时的控制函数,默认的控制函数什么都没处理,返回true

handleRightDown()

鼠标右键按下时的控制函数,默认的控制函数什么都没处理,返回true

handleRightUp()

鼠标右键抬起时的控制函数,默认的控制函数什么都没处理,返回true

handleRightClick()

鼠标右键单击时的控制函数,默认的控制函数什么都没处理,返回true

handleMouseMove()

鼠标移动时的控制函数,默认的控制函数什么都没处理,返回true

handleWheel()

鼠标滚轮滚动时的控制函数,默认的控制函数什么都没处理,返回true

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: