Class CombinedChart

Class for a combined chart. It is possible to combine more than 2 types of chart but there can only be two value axes."""

Hierarchy

Chart
- CombinedChart

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CombinedChart(name: string, charts: Chart[], secondaryCharts?: Chart[], options?: ChartOptions): CombinedChart

Overrides Chart.constructor
- Defined in src/elements/charts.ts:1435
Parameters
- name: string
  
  The name of the chart.
- charts: Chart[]
  
  Charts for the first y-axis.
- Optional secondaryCharts: Chart[]
  
  Charts for the secondary y-axis. Optional.
- Optional options: ChartOptions
  
  The options for the chart. Optional.
Returns CombinedChart

Properties

charts

charts: Chart[]

name

name: string

options

options: undefined | ChartOptions

secondaryCharts

secondaryCharts: undefined | Chart[]

Methods

asDict

asDict(): {}

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

Returns {}

dict representation of this object
- [key: string]: unknown

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

getModifiedChartDicts

getModifiedChartDicts(): object[]

- Defined in src/elements/charts.ts:1451
Replace the y-axis with the y2-axis for the secondary charts. Add the dict representation for each chart to a list and return that list.

Returns object[]

list containing the dict representation for each chart, after processing

Generated using TypeDoc