Class: SelectionSeries

• [new SelectionSeries(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.charts.selectionseries.selectionseries.md#new selectionseries(options))

• new SelectionSeries(options?)

EventDispatcher.constructor

▸ clear(data): SelectionSeries

Clears all indices for the provided selection state

SelectionSeries

▸ clear(seriesId?, state?): SelectionSeries

Clears all indices for the provided selection state

SelectionSeries

▸ contains(data, state?): ContainsType

Check if provided selection has intersection

ContainsType

▸ contains(index, seriesId, state?): ContainsType

Check if provided selection has intersection

ContainsType

▸ deselect(selection): SelectionSeries

Removes selection state from indices of the provided series

SelectionSeries

▸ deselect(data, state?): SelectionSeries

Removes selection state from indices of the provided series

SelectionSeries

▸ deselect(index, seriesId, state?): SelectionSeries

Removes selection state from indices of the provided series

SelectionSeries

▸ dispose(): void

Dispose.

void

EventDispatcher.dispose

▸ getClassName(): string

string

EventDispatcher.getClassName

▸ getIndices(seriesId, state?): number[]

Returns selected indices for the provided series

number[]

▸ getName(): string

Returns selection storage name

string

▸ getRawSelection(state?): Record<string, number[]&gt;

Returns key => value record where key is unique series selected and values are arrays of selected indices not rounded to integer numbers.

Record<string, number[]&gt;

▸ getRawSelection(seriesId, state): number[]

Returns array of selected indices for the series not rounded to integer numbers.

number[]

▸ getSelection(state?): Record<string, number[]&gt;

Returns key => value record where key is unique series selected and values are arrays of selected indices

Record<string, number[]&gt;

▸ getSelection(seriesId, state): number[]

Returns array of selected indices for the series.

number[]

▸ getStates(): string[]

Returns array of states which this series holds

string[]

▸ getTableId(): string

Returns selection table identifier

string

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

EventDispatcher.hasEventListener

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

EventDispatcher.isDisposed

▸ isEmpty(state?): boolean

Returns true if there're no series selected with the state provided, false otherwise

boolean

▸ isSelected(data, state?): boolean

Returns true if all the series and samples provided are selected, false otherwise

boolean

▸ isSelected(seriesId, state?): boolean

Returns true if all the series and samples provided are selected, false otherwise

boolean

▸ isSelected(index, seriesId, state?): boolean

Returns true if all the series and samples provided are selected, false otherwise

boolean

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

EventDispatcher.isSilent

▸ notify<E&gt;(type, source, args?): SelectionSeries

Notify listeners

SelectionSeries

this

EventDispatcher.notify

▸ off<E&gt;(type?, callback?): SelectionSeries

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

SelectionSeries

this

EventDispatcher.off

▸ on<E&gt;(type, callback): SelectionSeries

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target. </p>

SelectionSeries

this

EventDispatcher.on

▸ select(selection): SelectionSeries

Selects indices, adding new state onto it

SelectionSeries

▸ select(selection, state?): SelectionSeries

Selects indices for the series, adding new state onto it

SelectionSeries

▸ select(index, seriesId, state?): SelectionSeries

Selects indices for the series, adding new state onto it

SelectionSeries

▸ setName(name): SelectionSeries

Sets selection storage name

SelectionSeries

▸ setSelection(selection): SelectionSeries

Sets new indices of the series to be selected with the 'state' status NOTE: It completely overwrites entire selection

SelectionSeries

▸ setSelection(data, state?): SelectionSeries

Sets new indices of the series to be selected with the 'state' status NOTE: It completely overwrites entire selection

SelectionSeries

▸ setSelection(index, seriesId, state?): SelectionSeries

Sets new indices of the series to be selected with the 'state' status NOTE: It only overwrites selection with provided state

SelectionSeries

▸ setSilent(bool): SelectionSeries

Set silent mode

SelectionSeries

this

EventDispatcher.setSilent

▸ toggle(selection): SelectionSeries

Toggles indice(s) state for series provided (selects if was not selected, deselects otherwise)

SelectionSeries

▸ toggle(data, state?): SelectionSeries

Toggles indice(s) state for series provided (selects if was not selected, deselects otherwise)

SelectionSeries

▸ toggle(index, seriesId, state?): SelectionSeries

Toggles indice(s) state for series provided (selects if was not selected, deselects otherwise)

SelectionSeries

▸ Static getClassName(): string

string

EventDispatcher.getClassName