Class Toggle

A toggle is a type of action that can be on or off. The state is not persistent between restarts by default.

Hierarchy (View Summary)

Action
- Toggle

Constructors

constructor

new Toggle(id: string, options: ToggleOptions): Toggle
Parameters
- id: string
- options: ToggleOptions
Returns Toggle
Overrides Action.constructor
- Defined in types/custom/action.d.ts:311

Properties

`Optional`category

category?: string

click

click: (event?: Event) => void

Type Declaration

- (event?: Event): void
- Function to run when user uses the action successfully
  Parameters
  - Optionalevent: Event
  Returns void

`Optional`condition

condition?: any

description

description: string

icon

icon: string | (() => selected_layer)

id

id: string

keybind

keybind: Keybind

`Optional`linked_setting

linked_setting?: string

ID of a setting that the toggle is linked to

menu_node

menu_node: HTMLElement

name

name: string

node

node: HTMLElement

nodes

nodes: HTMLElement[]

`Optional`plugin

plugin?: string

The ID of the plugin that created the object

`Optional`side_menu

side_menu?: Menu | ToolConfig

Provide a menu that belongs to the action, and gets displayed as a small arrow next to it in toolbars.

`Optional`tool_config

tool_config?: ToolConfig

Provide a window with additional configutation related to the action

value

value: boolean

`Optional`variations

variations?: { [key: string]: { description?: string; name: string } }

`Static` `Optional`constructing

constructing?: BarItem

Methods

addLabel

addLabel(in_bar?: boolean, action?: any): void
Adds a label to the HTML element of the bar item
Parameters
- Optionalin_bar: boolean
  Set to true to generate an in-bar label, as opposed to a regular on-hover label
- Optionalaction: any
  Provide the action to generate the label. This defaults to self and is only needed in special cases
Returns void
Inherited from Action.addLabel
- Defined in types/custom/action.d.ts:184
addLabel(in_bar?: boolean, action?: any): void
Adds a label to the HTML element of the bar item
Parameters
- Optionalin_bar: boolean
  Set to true to generate an in-bar label, as opposed to a regular on-hover label
- Optionalaction: any
  Provide the action to generate the label. This defaults to self and is only needed in special cases
Returns void
Inherited from Action.addLabel
- Defined in types/custom/action.d.ts:220

conditionMet

conditionMet(): boolean
Returns boolean
Inherited from Action.conditionMet
- Defined in types/custom/action.d.ts:178
conditionMet(): boolean
Returns boolean
Inherited from Action.conditionMet
- Defined in types/custom/action.d.ts:214

delete

delete(): void
Returns void
Inherited from Action.delete
- Defined in types/custom/misc.d.ts:8

dispatchEvent

dispatchEvent<T = EventName>(event: T, ...args: any[]): void
Type Parameters
- T = EventName
Parameters
- event: T
- ...args: any[]
Returns void
Inherited from Action.dispatchEvent
- Defined in types/custom/action.d.ts:231

getNode

getNode(): HTMLElement
Gets a copy of the elements HTML node that is not yet in use.

Returns HTMLElement
Inherited from Action.getNode
- Defined in types/custom/action.d.ts:188
getNode(): HTMLElement
Gets a copy of the elements HTML node that is not yet in use.

Returns HTMLElement
Inherited from Action.getNode
- Defined in types/custom/action.d.ts:224

on

on(
event_name: ActionEventName,
callback: (data: Record<string, any>) => void,
): void
Adds an event listener to the item
Parameters
- event_name: ActionEventName
  The event type to listen for
- callback: (data: Record<string, any>) => void
Returns void
Inherited from Action.on
- Defined in types/custom/action.d.ts:200

once

once(
event_name: ActionEventName,
callback: (data: Record<string, any>) => void,
): void
Adds a single-use event listener to the item
Parameters
- event_name: ActionEventName
  The event type to listen for
- callback: (data: Record<string, any>) => void
Returns void
Inherited from Action.once
- Defined in types/custom/action.d.ts:206

pushToolbar

pushToolbar(bar: any): void
Parameters
- bar: any
Returns void
Inherited from Action.pushToolbar
- Defined in types/custom/action.d.ts:193
pushToolbar(bar: any): void
Parameters
- bar: any
Returns void
Inherited from Action.pushToolbar
- Defined in types/custom/action.d.ts:229

removeListener

removeListener(
event_name: ActionEventName,
callback: (data: Record<string, any>) => void,
): void
Removes an event listener from the item
Parameters
- event_name: ActionEventName
- callback: (data: Record<string, any>) => void
Returns void
Inherited from Action.removeListener
- Defined in types/custom/action.d.ts:212

set

set(value: boolean): this
Parameters
- value: boolean
Returns this
- Defined in types/custom/action.d.ts:320

setIcon

setIcon(icon: string): void
Change the icon of the action
Parameters
- icon: string
Returns void
Overrides Action.setIcon
- Defined in types/custom/action.d.ts:321

setName

setName(name: string): void
Change the name of the action
Parameters
- name: string
Returns void
Inherited from Action.setName
- Defined in types/custom/action.d.ts:286

toElement

toElement(destination: string | HTMLElement): this
Appends the bar item to a HTML element
Parameters
- destination: string | HTMLElement
Returns this
Inherited from Action.toElement
- Defined in types/custom/action.d.ts:192
toElement(destination: HTMLElement): this
Appends the bar item to a HTML element
Parameters
- destination: HTMLElement
Returns this
Inherited from Action.toElement
- Defined in types/custom/action.d.ts:228

toggleLinkedSetting

toggleLinkedSetting(change: any): void
Parameters
- change: any
Returns void
Inherited from Action.toggleLinkedSetting
- Defined in types/custom/action.d.ts:289

trigger

trigger(event?: Event): boolean
Trigger to run or select the action. This is the equivalent of clicking or using a keybind to trigger it. Also checks if the condition is met.
Parameters
- Optionalevent: Event
Returns boolean
Inherited from Action.trigger
- Defined in types/custom/action.d.ts:281

updateEnabledState

updateEnabledState(): void
Updates the state of the toggle in the UI

Returns void
- Defined in types/custom/action.d.ts:315

updateKeybindingLabel

updateKeybindingLabel(): this
Returns this
Inherited from Action.updateKeybindingLabel
- Defined in types/custom/action.d.ts:282

Class Toggle

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Toggle

Properties

Optionalcategory

click

Type Declaration

Parameters

Returns void

Optionalcondition

description

icon

id

keybind

Optionallinked_setting

menu_node

name

node

nodes

Optionalplugin

Optionalside_menu

Optionaltool_config

value

Optionalvariations

Static Optionalconstructing

Methods

addLabel

Parameters

Returns void

Parameters

Returns void

conditionMet

Returns boolean

Returns boolean

delete

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

getNode

Returns HTMLElement

Returns HTMLElement

on

Parameters

Returns void

once

Parameters

Returns void

pushToolbar

Parameters

Returns void

Parameters

Returns void

removeListener

Parameters

Returns void

set

Parameters

Returns this

setIcon

Parameters

Returns void

setName

Parameters

Returns void

toElement

Parameters

Returns this

Parameters

Returns this

toggleLinkedSetting

Parameters

`Optional`category

`Optional`condition

`Optional`linked_setting

`Optional`plugin

`Optional`side_menu

`Optional`tool_config

`Optional`variations

`Static` `Optional`constructing