Class SearchBox<T>

base class for event dispatching using d3 event mechanism, thus .suffix is supported for multiple registrations

Type Parameters

T extends IItem

Hierarchy (view full)

AEventDispatcher
- SearchBox

Index

Constructors

Properties

node EVENT_SELECT

Accessors

Methods

createEventList fire focus forward listenersChanged on unforward

Constructors

constructor

new SearchBox<T>(options?): SearchBox<T>
Type Parameters
- T extends IItem
Parameters
- options: Partial<ISearchBoxOptions<T>> = {}
Returns SearchBox<T>
Overrides AEventDispatcher.constructor
- Defined in ui/panel/SearchBox.ts:53

Properties

`Readonly` node

node: HTMLElement

`Static` `Readonly` EVENT_SELECT

EVENT_SELECT: "select" = 'select'

Accessors

data

get data(): (T | IGroupSearchItem<T>)[]
Returns (T | IGroupSearchItem<T>)[]
- Defined in ui/panel/SearchBox.ts:79
set data(data): void
Parameters
- data: (T | IGroupSearchItem<T>)[]
Returns void
- Defined in ui/panel/SearchBox.ts:83

Methods

`Protected` createEventList

createEventList(): string[]
return the list of events to be able to dispatch

Returns string[]
by default no events
Overrides AEventDispatcher.createEventList
- Defined in ui/panel/SearchBox.ts:222

`Protected` fire

fire(type, ...args): void
Parameters
- type: string | string[]
- Rest ...args: any[]
Returns void
Inherited from AEventDispatcher.fire
- Defined in internal/AEventDispatcher.ts:101

focus

focus(): void
Returns void
- Defined in ui/panel/SearchBox.ts:140

`Protected` forward

forward(from, ...types): void
forwards one or more events from a given dispatcher to the current one i.e. when one of the given events is fired in 'from' it will be forwarded to all my listeners
Parameters
- from: IEventHandler
  the event dispatcher to forward from
- Rest ...types: string[]
  the event types to forward
Returns void
Inherited from AEventDispatcher.forward
- Defined in internal/AEventDispatcher.ts:137

`Protected` listenersChanged

listenersChanged(_type, _active): void
helper function that will be called upon a listener has changed
Parameters
- _type: string
  event type
- _active: boolean
  registered or de registered
Returns void
Inherited from AEventDispatcher.listenersChanged
- Defined in internal/AEventDispatcher.ts:89

on

on(type, listener): this
Parameters
- type: "select"
- listener: ((item) => void)
  - - (item): void
    - Parameters
      item: any
      Returns void
      As Member Of
      SearchBox
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in ui/panel/SearchBox.ts:226
on(type, listener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Overrides AEventDispatcher.on
- Defined in ui/panel/SearchBox.ts:227

`Protected` unforward

unforward(from, ...types): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  the originated dispatcher
- Rest ...types: string[]
  event types to forward
Returns void
Inherited from AEventDispatcher.unforward
- Defined in internal/AEventDispatcher.ts:146