Class Tools

A default button with a "tools" icon

Hierarchy

Button
- Tools

Index

Constructors

Properties

button childControls iconClassName on unicode

Methods

getButton getChildControls getElement handleEvent setButtonIconClassName setButtonUnicode setChildControls setMap getIconElementForIconClassName getIconElementForUnicode

Constructors

constructor

new Tools(options?: ButtonOptions): Tools
Parameters
- Optional options: ButtonOptions
  
  the button options
Returns Tools
Overrides Button.constructor
- Defined in bgis/ol/control/Tools.ts:12

Properties

`Protected` button

button: HTMLButtonElement

The HTML element of the button *

`Protected` childControls

childControls: Control[]

The child controls

`Protected` iconClassName

iconClassName: null | string

The icons css class name *

on

on: ButtonOnSignature<EventsKey>

`Protected` unicode

unicode: null | number

The unicode for the font icon *

Methods

getButton

getButton(): HTMLButtonElement
The getter for the button

Returns HTMLButtonElement
Inherited from Button.getButton
- Defined in bgis/ol/control/base/Button.ts:152

`Protected` getChildControls

getChildControls(): Control[]
Protected
A getter for the child controls

Returns Control[]
Inherited from Button.getChildControls
- Defined in bgis/ol/control/base/CompositeControl.ts:70

getElement

getElement(): HTMLElement
A getter for the element

Returns HTMLElement
Inherited from Button.getElement
- Defined in bgis/ol/control/base/CompositeControl.ts:85

handleEvent

handleEvent(event: BaseEvent): boolean
This is the default click handler of a button

Override it for your benefit or disable execution with options.preventDefault
Parameters
- event: BaseEvent
Returns boolean
Inherited from Button.handleEvent
- Defined in bgis/ol/control/base/Button.ts:145

setButtonIconClassName

setButtonIconClassName(iconClassName: string): void
A setter to change the icon class name for the button. Resets the unicode for the button icon.
Parameters
- iconClassName: string
Returns void
Inherited from Button.setButtonIconClassName
- Defined in bgis/ol/control/base/Button.ts:172

setButtonUnicode

setButtonUnicode(unicode: number): void
A setter to change the unicode for the button font icon. Removes the icon tag for the button icon.
Parameters
- unicode: number
Returns void
Inherited from Button.setButtonUnicode
- Defined in bgis/ol/control/base/Button.ts:161

setChildControls

setChildControls(childControls: Control[]): void
A setter for the child controls
Parameters
- childControls: Control[]
Returns void
Inherited from Button.setChildControls
- Defined in bgis/ol/control/base/CompositeControl.ts:78

setMap

setMap(map: Map): void
The overridden setMap method

Here we set the map for all child controls
Parameters
- map: Map
  
  the current map
Returns void
Inherited from Button.setMap
- Defined in bgis/ol/control/base/CompositeControl.ts:57

`Static` `Protected` getIconElementForIconClassName

getIconElementForIconClassName(iconClassName: string): HTMLElement
Protected
Get an icon element for the given css class name
Parameters
- iconClassName: string
Returns HTMLElement
Inherited from Button.getIconElementForIconClassName
- Defined in bgis/ol/control/base/Button.ts:184

`Static` `Protected` getIconElementForUnicode

getIconElementForUnicode(unicode: number): HTMLElement
Protected
Get an icon element for the given unicode font
Parameters
- unicode: number
Returns HTMLElement
Inherited from Button.getIconElementForUnicode
- Defined in bgis/ol/control/base/Button.ts:196

Generated using TypeDoc