Class ToggleButton

A Button to toggle the visibility of a Container

Hierarchy

Button
- ToggleButton

Constructors

constructor

new ToggleButton(options: ToggleButtonOptions): ToggleButton
Parameters
- options: ToggleButtonOptions
  
  The options
Returns ToggleButton
Overrides Button.constructor
- Defined in bgis/ol/control/base/ToggleButton.ts:62

Properties

`Protected` _isToggled

_isToggled: boolean

The flag of the toggle status *

`Protected` button

button: HTMLButtonElement

The HTML element of the button *

`Protected` childControls

childControls: Control[]

The child controls

`Protected` containerToToggle

containerToToggle: Container

The Container which visibility get toggled *

`Protected` iconClassName

iconClassName: null | string

The icons css class name *

`Protected` iconClassNameToggled

iconClassNameToggled: null | string

The css class name of the font icon visible when the button is clicked *

on

on: ButtonOnSignature<EventsKey>

`Protected` unicode

unicode: null | number

The unicode for the font icon *

`Protected` unicodeToggled

unicodeToggled: null | number

The unicode of the font icon visible when the button is clicked *

Accessors

isToggled

get isToggled(): boolean
A getter for the toggled state of the button

Returns boolean
- Defined in bgis/ol/control/base/ToggleButton.ts:132
set isToggled(isToggled: boolean): void
A setter for the toggled state of the button
Parameters
- isToggled: boolean
Returns void
- Defined in bgis/ol/control/base/ToggleButton.ts:125

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

getContainerToToggle

getContainerToToggle(): Container
A getter for the container to toggle

Returns Container
- Defined in bgis/ol/control/base/ToggleButton.ts:139

getElement

getElement(): HTMLElement
A getter for the element

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

`Protected` getParentElement

getParentElement(): null | Element
Protected
Get the closest parent element for toggle. For the core feature version it's the .bgis-map For the full feature version it's the .bgis

Returns null | Element
- Defined in bgis/ol/control/base/ToggleButton.ts:149

handleEvent

handleEvent(event: BaseEvent): boolean
The overridden handleEvent method
Parameters
- event: BaseEvent
Returns boolean
Overrides Button.handleEvent
- Defined in bgis/ol/control/base/ToggleButton.ts:84

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

Class ToggleButton

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ToggleButtonOptions

Returns ToggleButton

Properties

Protected _isToggled

Protected button

Protected childControls

Protected containerToToggle

Protected iconClassName

Protected iconClassNameToggled

on

Protected unicode

Protected unicodeToggled

Accessors

isToggled

Returns boolean

Parameters

isToggled: boolean

Returns void

Methods

getButton

Returns HTMLButtonElement

Protected getChildControls

Returns Control[]

getContainerToToggle

Returns Container

getElement

Returns HTMLElement

Protected getParentElement

Returns null | Element

handleEvent

Parameters

event: BaseEvent

Returns boolean

setButtonIconClassName

Parameters

iconClassName: string

Returns void

setButtonUnicode

Parameters

unicode: number

Returns void

setChildControls

Parameters

childControls: Control[]

Returns void

setMap

Parameters

map: Map

Returns void

Static Protected getIconElementForIconClassName

Parameters

iconClassName: string

Returns HTMLElement

Static Protected getIconElementForUnicode

Parameters

unicode: number

Returns HTMLElement

Settings

Member Visibility

Theme

`Protected` _isToggled

`Protected` button

`Protected` childControls

`Protected` containerToToggle

`Protected` iconClassName

`Protected` iconClassNameToggled

`Protected` unicode

`Protected` unicodeToggled

`Protected` getChildControls

`Protected` getParentElement

`Static` `Protected` getIconElementForIconClassName

`Static` `Protected` getIconElementForUnicode