Discussions

Tools

Tools

addTool(tool)

Adds a tool to the player.
Kind: inner method of Tools

parametertype
toolstring | Tool
player.tools.addTool('orbit')

addTools(tools)

Adds an array of tools to the player.
Kind: inner method of Tools

parametertype
toolsarray | (string|Tool)
player.tools.addTools(['pan', 'orbit', 'zoom'])

setTool(key, attrs)

Updates an existing tool.
Kind: inner method of Tools

parametertype
keystring
attrsTool
player.tools.setTool('orbit', { enabled: false })

setTools(tools)

Updates existing tools.
Kind: inner method of Tools

parametertype
toolsobject l string, Tool
player.tools.setTools({ 'orbit', { enabled: false }, 'pan': { enabled: true } })

removeTool(toolName)

Removes a tool from the player.
Kind: inner method of Tools

parametertype
toolNamestring
player.tools.removeTool('orbit')

removeTools(toolNames)

Removes an array of tools from the player.
Kind: inner method of Tools

parametertype
toolNamesArray | string
player.tools.removeTools(['pan', 'orbit', 'zoom'])

setPrimary(toolName)

Sets a tool as Primary tool.
Kind: inner method of Tools

parametertype
toolNamestring
player.tools.setPrimary('zoom')

getPrimaryTool()

Gets the current primary tool.
Kind: inner method of Tools
Returns: string -

player.tools.getPrimaryTool()