Class ChartElementSelection

The chart element selection of a sheet's view, or of one chart.

Hierarchy

ItemSelection<IElement>
- ChartElementSelection

Implements

IChartElementSelection

Index

Constructors

constructor

new ChartElementSelection(
options?: IChartElementSelection.ConstructorOptions,
): ChartElementSelection
Parameters
- Optionaloptions: IChartElementSelection.ConstructorOptions
Returns ChartElementSelection

Overrides ItemSelection<IChart.IElement>.constructor

Accessors

[toStringTag]

get "[toStringTag]"(): string

Returns string

isIChartElementSelection

get isIChartElementSelection(): true

For runtime type checking.

Returns true

Implementation of IChartElementSelection.isIChartElementSelection

Methods

addListeners

addListeners(
listeners: IChartElementSelection.IListeners,
options?: IListener.Options,
): Remove
Adds listeners to the selection.
Parameters
- listeners: IChartElementSelection.IListeners
  The listeners to add.
- Optionaloptions: IListener.Options
  Options for the listeners.
Returns Remove
A function to remove the listeners.

Implementation of IChartElementSelection.addListeners

Overrides ItemSelection.addListeners

clear

clear(): this

Empties the selection.

Returns this

Implementation of IChartElementSelection.clear

Inherited from ItemSelection.clear

getActive

getActive(): IElement | null

Returns the item selected most recently, or null when the selection is empty.

Returns IElement | null

Implementation of IChartElementSelection.getActive

Inherited from ItemSelection.getActive

getChart

getChart(): IChart | null

Returns the chart the selected elements are of, or null when the selection is empty.

Returns IChart | null

Implementation of IChartElementSelection.getChart

getContainer

getContainer(): IElement | null

Returns what every selected item shares as its parent: null for the root (the sheet, the chart), else the group or element they are in.

Returns IElement | null

Remarks
null when the selection is empty.

Implementation of IChartElementSelection.getContainer

Inherited from ItemSelection.getContainer

getItems

getItems(): readonly IElement[]

Returns the selected items, in the order the selection keeps them.

Returns readonly IElement[]

Implementation of IChartElementSelection.getItems

Inherited from ItemSelection.getItems

isEmpty

isEmpty(): boolean

Returns true if nothing is selected.

Returns boolean

Implementation of IChartElementSelection.isEmpty

Inherited from ItemSelection.isEmpty

isEquals

isEquals(other: IItemSelection<IElement>): boolean
Returns true if other selects the same items, with the same one active.
Parameters
- other: IItemSelection<IElement>
Returns boolean

Implementation of IChartElementSelection.isEquals

Inherited from ItemSelection.isEquals

isSelected

isSelected(item: IElement): boolean
Returns true if item is selected.
Parameters
- item: IElement
Returns boolean

Implementation of IChartElementSelection.isSelected

Inherited from ItemSelection.isSelected

select

select(items: readonly IElement[], options?: IItemSelection.SelectOptions): this
Selects items, replacing the selection.
Parameters
- items: readonly IElement[]
  The items to select, the last one the active one.
- Optionaloptions: IItemSelection.SelectOptions
  With add, extends the selection instead.
Returns this

Remarks
Items are taken in order, as picks: one in another container than those selected before it replaces them.

Implementation of IChartElementSelection.select

Inherited from ItemSelection.select

traverse

traverse(reverse?: boolean): this
Selects the next item, alone: what pressing Tab does.
Parameters
- reverse: boolean = false
  Selects the previous one instead.
Returns this

Remarks
Wraps at the ends. With nothing selected, starts from the first (or, in reverse, the last).

Implementation of IChartElementSelection.traverse

Inherited from ItemSelection.traverse

unselect

unselect(items: readonly IElement[]): this
Removes items from the selection. Items not selected are ignored.
Parameters
- items: readonly IElement[]
Returns this

Implementation of IChartElementSelection.unselect

Inherited from ItemSelection.unselect

Class ChartElementSelection

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ChartElementSelection

Accessors

[toStringTag]

Returns string

isIChartElementSelection

Returns true

Methods

addListeners

Parameters

Returns Remove

clear

Returns this

getActive

Returns IElement | null

getChart

Returns IChart | null

getContainer

Returns IElement | null

Remarks

getItems

Returns readonly IElement[]

isEmpty

Returns boolean

isEquals

Parameters

Returns boolean

isSelected

Parameters

Returns boolean

select

Parameters

Returns this

Remarks

traverse

Parameters

Returns this

Remarks

unselect

Parameters

Returns this

Settings

On This Page