EventObj

new CooSDK.EventObj(props)

事件对象。提供键盘、鼠标、授权在SDK中的回调触发。 需要注意的是,在非IE浏览器下,鼠标事件不支持PPPCallback类型的回调,即仅支持传递屏幕坐标。

Name Type Description
props Object optional

包含如下属性的Object:

Name Type Default Description
isGetGeo Boolean true optional

鼠标相关事件返回值是否返回经纬度坐标,若为false,则返回屏幕坐标。

hotkeyArray Array.<Array.<String>> [] optional

键盘热键组合,可以传入多组热键;当使用热键组合时请勿使用“keyDownCallback”和“keyUpCallback”事件。

hotkeyCallback PPPCallback | PPCallback | String "none" optional

键盘热键组合回调。

keyDownCallback CBCallback | String "none" optional

键盘按键按下事件绑定函数,参数(nChar)。

keyUpCallback CBCallback | String "none" optional

键盘按键弹起事件绑定函数,参数(nChar)。

lbtnDblClkCallback PPPCallback | PPCallback | String "none" optional

鼠标左键双击事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

lbtnDownCallback PPPCallback | PPCallback | String "none" optional

鼠标左键按下事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

lbtnUpCallback PPPCallback | PPCallback | String "none" optional

鼠标左键弹起事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

licStateCallback CBCallback | String "none" optional

授权状态事件绑定函数,参数(state)。

licCloseStateCallback CBCallback | String "none" optional

授权关闭窗口事件绑定函数,参数(state)。

mbtnDblClkCallback PPPCallback | PPCallback | String "none" optional

鼠标中键双击事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mbtnDownCallback PPPCallback | PPCallback | String "none" optional

鼠标中键按下事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mbtnUpCallback PPPCallback | PPCallback | String "none" optional

鼠标中键弹起事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mouseHoverCallback PPPCallback | PPCallback | String "none" optional

鼠标悬停事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mouseMoveCallback PPPCallback | PPCallback | String "none" optional

鼠标移动事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mouseWheelCallback PPPCallback | PPCallback | String "none" optional

鼠标滚轮滑动事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

rbtnDblClkCallback PPPCallback | PPCallback | String "none" optional

鼠标右键双击事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

rbtnDownCallback PPPCallback | PPCallback | String "none" optional

鼠标右键按下事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

rbtnUpCallback PPPCallback | PPCallback | String "none" optional

鼠标右键弹起事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

Example:
// 该对象仅可创建一次,所有事件均在一个对象内进行设置
var eventObj = new CooSDK.EventObj({
     // 绑定的响应函数
     lbtnDownCallback: test
});

function test(x, y, z) {
     console.log("鼠标左键按下经纬度坐标:" + x + ',' + y + ',' + z);
}

// 解除绑定
eventObj.lbtnDownCallback = "none";

//键盘热键功能
var eventObj = new CooSDK.EventObj({
     //可传入多组热键组合,每组组合键以数组方式依次存储其按键名称,按键名称无大小写限制
     hotkeyArr=[['Ctrl','Shift','a'],['Shift','s'],['tab','F1']],
     // 绑定的响应函数,以其中一组热键按下成功触发后,会返回该组合键所在整个“hotkeyArray”二维数组的索引位置。例如按下'Shift'+'s'组合键,触发test会返回“1”。
     hotkeyCallback: test
});

Members

hotkeyArray : Array.<Array.<String>>

获取或者设置键盘的热键组合,每组组合键以数组方式依次存储其按键名称,如[['f1','A']],按键名称无大小写限制,可以设置多组热键,而后绑定“hotkeyCallback”事件绑定函数, 以其中一组热键按下成功触发后,会返回该组合键所在整个“hotkeyArray”二维数组的索引位置。支持的热键及其对应键值如下: 'backspace':'8', 'tab':'9', 'clear':'12', 'enter':'13', 'shift':'16', 'ctrl': '17', 'alt':'18', 'pause':'19', 'caps lock':'20', 'escape': '27', 'space': '32', 'page up': '33', 'page down': '34', 'end': '35', 'home': '36', 'left': '37', 'up': '38', 'right': '39', 'down': '40', 'select': '41', 'print': '42', 'execute': '43', 'insert': '45', 'delete': '46', "help": '47', '0': '48', '1': '49', '2': '50', '3': '51', '4': '52', '5': '53', '6': '54', '7': '55', '8': '56', '9': '57', 'a': '65', 'b': '66', 'c': '67', 'd': '68', 'e': '69', 'f': '70', 'g': '71', 'h': '72', 'i': '73', 'j': '74', 'k': '75', 'l': '76', 'm': '77', 'n': '78', 'o': '79', 'p': '80', 'q': '81', 'r': '82', 's': '83', 't': '84', 'u': '85', 'v': '86', 'w': '87', 'x': '88', 'y': '89', 'z': '90', 'left windows': '91', 'right windows': '92', '*': '106', '+': '107', '-': '109', '.': '110', '/': '111', 'f1': '112', 'f2': '113', 'f3': '114', 'f4': '115', 'f5': '116', 'f6': '117', 'f7': '118', 'f8': '119', 'f9': '120', 'f10': '121', 'f11': '122', 'f12': '123', 'f13': '124', 'num lock': '144', "scroll lock": "145",

Default Value: []

hotkeyCallback : CBCallback|String

获取或者设置键盘热键组合键按下事件绑定函数,参数(nChar)。

Default Value: "none"

isGetGeo : Boolean

获取或者设置鼠标相关事件返回值是否返回经纬度坐标,若为false,则返回屏幕坐标。

Default Value: true

keyDownCallback : CBCallback|String

获取或者设置键盘按键按下事件绑定函数,参数(nChar)。

Default Value: "none"

keyUpCallback : CBCallback|String

获取或者设置键盘按键弹起事件绑定函数,参数(nChar)。

Default Value: "none"

lbtnDblClkCallback : PPPCallback|PPCallback|String

获取或者设置鼠标左键双击事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

lbtnDownCallback : PPPCallback|PPCallback|String

获取或者设置鼠标左键按下事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

lbtnUpCallback : PPPCallback|PPCallback|String

获取或者设置鼠标左键弹起事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

licStateCallback : CBCallback|String

获取或者设置授权状态事件绑定函数,参数(state)。

Default Value: "none"

loadCallback : CBCallback|String

获取或者设置数据加载完成时触发的回调函数。

Default Value: "none"

mbtnDblClkCallback : PPPCallback|PPCallback|String

获取或者设置鼠标中键双击事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

mbtnDownCallback : PPPCallback|PPCallback|String

获取或者设置鼠标中键按下事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

mbtnUpCallback : PPPCallback|PPCallback|String

获取或者设置鼠标中键弹起事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

mouseHoverCallback : PPPCallback|PPCallback|String

获取或者设置鼠标悬停事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

mouseMoveCallback : PPPCallback|PPCallback|String

获取或者设置鼠标移动事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

mouseWheelCallback : PPPCallback|PPCallback|String

获取或者设置鼠标滚轮滑动事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

rbtnDblClkCallback : PPPCallback|PPCallback|String

获取或者设置鼠标右键双击事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

rbtnDownCallback : PPPCallback|PPCallback|String

获取或者设置鼠标右键按下事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

rbtnUpCallback : PPPCallback|PPCallback|String

获取或者设置鼠标右键弹起事件绑定函数,参数(xPos,yPos)。

Default Value: "none"

Methods

destroy()

从场景中销毁自身。

Returns:

null 空值。

Example:
// 销毁对象
eventObj = eventObj.destroy();

update(props)

更新单个或者多个对象属性,使之立即生效。

一般用于多个属性的同时更新,避免性能开销过大。

Name Type Description
props Object optional

包含如下属性的Object:

Name Type Description
isGetGeo Boolean optional

鼠标相关事件返回值是否返回经纬度坐标,若为false,则返回屏幕坐标。

hotkeyArray CBCallback | String optional

键盘热键组合,可以传入多组热键;当使用热键组合时请勿使用“keyDownCallback”和“keyUpCallback”事件。

hotkeyCallback CBCallback | String optional

键盘热键组合回调。

keyDownCallback CBCallback | String optional

键盘按键按下事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

keyUpCallback CBCallback | String optional

键盘按键弹起事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

lbtnDblClkCallback PPPCallback | PPCallback | String optional

鼠标左键双击事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

lbtnDownCallback PPPCallback | PPCallback | String optional

鼠标左键按下事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

lbtnUpCallback PPPCallback | PPCallback | String optional

鼠标左键弹起事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

licStateCallback CBCallback | String optional

授权状态事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mbtnDblClkCallback PPPCallback | PPCallback | String optional

鼠标中键双击事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mbtnDownCallback PPPCallback | PPCallback | String optional

鼠标中键按下事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mbtnUpCallback PPPCallback | PPCallback | String optional

鼠标中键弹起事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mouseHoverCallback PPPCallback | PPCallback | String optional

鼠标悬停事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mouseMoveCallback PPPCallback | PPCallback | String optional

鼠标移动事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

mouseWheelCallback PPPCallback | PPCallback | String optional

鼠标滚轮滑动事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

rbtnDblClkCallback PPPCallback | PPCallback | String optional

鼠标右键双击事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

rbtnDownCallback PPPCallback | PPCallback | String optional

鼠标右键按下事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。

rbtnUpCallback PPPCallback | PPCallback | String optional

鼠标右键弹起事件绑定函数,参数(xPos,yPos,zPos)或者参数(xPos,yPos)。