Class Psychart

Generates an interactive psychrometric chart with plotting capabilities.

Hierarchy

Chart<PsychartTypes.Options>
- Psychart

Index

Constructors

Methods

clearData distance getElement getXY plot getRegionNamesAndTips

Constructors

constructor

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

Methods

clearData

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

Returns void

distance

distance(state1: PsychartTypes.State, state2: PsychartTypes.State): number
Calculate the distance between 2 states, in pixels. Note: Relative humidity must be in range [0.0-1.0]
Parameters
- state1: PsychartTypes.State
- state2: PsychartTypes.State
Returns number
Deprecated
Please use Psychart.getXY(state)

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

getXY

getXY(state: PsychartTypes.State): PsychartTypes.Point
Calculate the (x,y) coordinates for any state. Note: Relative humidity must be in range [0.0-1.0]
Parameters
- state: PsychartTypes.State
Returns PsychartTypes.Point

plot

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

`Static`getRegionNamesAndTips

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

Returns [Region, string][]