Class BarChart

Class for a bar chart

Hierarchy

Chart
- BarChart

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BarChart(name: string, bars: (XYSeries | BarSeries)[], options?: ChartOptions): BarChart

Overrides Chart.constructor
- Defined in src/elements/charts.ts:955
Parameters
- name: string
  
  The name of the chart.
- bars: (XYSeries | BarSeries)[]
  
  Iterable of bar series.
- Optional options: ChartOptions
  
  The options for the chart. Optional.
Returns BarChart

Properties

bars

bars: (XYSeries | BarSeries)[]

name

name: string

options

options: undefined | ChartOptions

Methods

asDict

asDict(): {}

Overrides Chart.asDict
- Defined in src/elements/charts.ts:964
The dict representation of this object

Returns {}

dict representation of this object
- [key: string]: string | {}

availableTags

availableTags(): Set<string>

Inherited from Chart.availableTags
- Defined in src/elements/charts.ts:908
A set containing all available template tags this Element reacts to.

Returns Set<string>

set of tags associated with this Element

getDict

getDict(updates: {}): {}

Inherited from Chart.getDict
- Defined in src/elements/charts.ts:890
Update the given dict with the chart options and return the result.

Parameters
- updates: {}
  
  the dict that needs to be updated with the chart options
  - [key: string]: unknown
Returns {}

the input dict, updated with the chart options

Generated using TypeDoc