Class Psychart

Generates an interactive psychrometric chart with plotting capabilities.

Index

Constructors

Methods

clearData clearRegions drawRegion getElement plot generateGradientIcon getDefaultStyleOptions getGradientNames getRegionNamesAndTips

Constructors

constructor

new Psychart(layout: Layout, config: PsyOptions, style: StyleOptions): Psychart
Construct a new instance of Psychart given various configuration properties.
Parameters
- layout: Layout
- config: PsyOptions
- style: StyleOptions
Returns Psychart

Methods

clearData

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

Returns void

clearRegions

clearRegions(): void
Clear all rendered regions from Psychart.

Returns void

drawRegion

drawRegion(states: Datum[], color: Color, tooltip?: string): void
Draw a shaded region on Psychart.
Parameters
- states: Datum[]
- color: Color
- Optionaltooltip: string
Returns void

getElement

getElement(): SVGElement
Return the SVG element to append on the parent.

Returns SVGElement

plot

plot(
    state: Datum,
    id?: number,
    time?: number,
    startTime?: number,
    endTime?: number,
): void
Plot one psychrometric state onto the psychrometric chart.
Parameters
- state: Datum
- id: number = 0
- time: number = ...
- startTime: number = ...
- endTime: number = ...
Returns void

`Static`generateGradientIcon

generateGradientIcon(gradient: PaletteName): string
Generate an SVG element to use as this gradient's icon. Returns the outer HTML string to be saved in a file.
Parameters
- gradient: PaletteName
Returns string

`Static`getDefaultStyleOptions

getDefaultStyleOptions(isDarkTheme: boolean): StyleOptions
Return some suggested style options based on if the current display is dark or light theme.
Parameters
- isDarkTheme: boolean
Returns StyleOptions

`Static`getGradientNames

getGradientNames(): PaletteName[]
Return an array of all allowed gradient names.

Returns PaletteName[]

`Static`getRegionNamesAndTips

getRegionNamesAndTips(): [RegionName, string][]
Return an array of region names and their corresponding tooltips.

Returns [RegionName, string][]