Class LayerSwitcher

Methods for interacting with LayerSwitcher.

Index

Methods

addLayerCheckbox isLayerCheckboxChecked removeLayerCheckbox setLayerCheckboxChecked

Methods

addLayerCheckbox

addLayerCheckbox(__namedParameters: { isChecked?: boolean; name: string }): void
Add a new checkbox to the SDK Layer checkboxes list
Parameters
- __namedParameters: { isChecked?: boolean; name: string }
  - OptionalisChecked?: boolean
    Optional. Initial checked state of the checkbox. Defaults to false.
  - name: string
    The name of the checkbox to add.
Returns void
Throws
InvalidStateError if the checkbox with the specified name already exists for this script

isLayerCheckboxChecked

isLayerCheckboxChecked(args: { name: string }): boolean
Get checked state of the SDK Layers checkbox
Parameters
- args: { name: string }
  - name: string
    The name of the checkbox to get checked state.
Returns boolean
value of the checkbox

Throws
InvalidStateError if a checkbox with the specified name does not exist for this script

removeLayerCheckbox

removeLayerCheckbox(args: { name: string }): void
Remove the checkbox from the SDK Layers checkboxes
Parameters
- args: { name: string }
  - name: string
    The name of the checkbox to remove.
Returns void
Throws
InvalidStateError if a checkbox with the specified name does not exist for this script

setLayerCheckboxChecked

setLayerCheckboxChecked(args: { isChecked: boolean; name: string }): void
Set checked state for the SDK Layers checkbox
Parameters
- args: { isChecked: boolean; name: string }
  - isChecked: boolean
    The checked state to set to checkbox.
  - name: string
    The name of the checkbox to set checked state.
Returns void
Throws
InvalidStateError if a checkbox with the specified name does not exist for this script