Options
All
  • Public
  • Public/Protected
  • All
Menu

SelectBoxListener API.

Hierarchy

  • SelectBoxListener

Index

Properties

__initialized

__initialized: boolean

[internal] Whether this selection box listener is initalized. This listener cannot be initialized twice.

containerEl

containerEl: HTMLElement

The container to use for the selection box. This will contain the selectable items.

detectionGridSize

detectionGridSize: { h: number; w: number }

Detection grid cell size. Lower values will ensure better precision, but will also negatively impact performance. The default is recommended for most cases.

Type declaration

  • h: number
  • w: number

disabled

disabled: boolean

Whether to disable the selection box lister.

minProcessingSize

minProcessingSize: { h: number; w: number }

Minimum box size to process events further.

Type declaration

  • h: number
  • w: number

Methods

getSelectedItems

  • getSelectedItems(): NodeList
  • Returns all selected items.

    Returns NodeList

    The selected items.

init

  • init(): void
  • Inits the select box listener.

    Returns void

onselectionfinished

  • onselectionfinished(): void
  • Called when a selection has been completed.

    Returns void

onselectionstart

  • Called on selection start.

    Parameters

    Returns void

uninit

  • uninit(): void
  • Destroys this listener.

    Returns void

Generated using TypeDoc