Class Psychart

Generates an interactive psychrometric chart with plotting capabilities.

Hierarchy

Chart<PsychartOptions>
- Psychart

Index

Constructors

Methods

clearData getElement plot getRegionNamesAndTips

Constructors

constructor

new Psychart(options?: Partial<PsychartOptions>): Psychart
Construct a new instance of Psychart given various configuration properties.
Parameters
- options: Partial<PsychartOptions> = {}
Returns Psychart
Overrides Chart<PsychartOptions>.constructor

Methods

clearData

clearData(): void
Clear all plotted data from Psychart.

Returns void

getElement

getElement(): HTMLDivElement
Return the base <div> element for this chart to append on the parent.

Returns HTMLDivElement
The base element.

Inherited from Chart.getElement

plot

plot(state: PsychartState, config?: Partial<PsychartDataOptions>): void
Plot one psychrometric state onto the psychrometric chart.
Parameters
- state: PsychartState
- config: Partial<PsychartDataOptions> = {}
Returns void

`Static`getRegionNamesAndTips

getRegionNamesAndTips(): [RegionName, string][]
Helper function to return an array of region names and their corresponding tooltips.

Returns [RegionName, string][]