npm.nicfv.com
    Preparing search index...

    Interface PsychartOptions

    Configuration options for Psychart.

    interface PsychartOptions {
        altitude: number;
        colors: { axis: string; font: string; regionGradient: PaletteName };
        dbMax: number;
        dbMin: number;
        dpMax: number;
        flipGradients: boolean;
        flipXY: boolean;
        font: { name: string; size: number };
        legend: false | { margin: Point; size: Point; title: string };
        lineHeight: number;
        major: { humRat: number; relHum: number; temp: number };
        padding: Point;
        regions: RegionName[];
        resolution: number;
        showUnits: { axis: boolean; tooltip: boolean };
        size: Point;
        unitSystem: "IP" | "SI";
        yAxis: "hr" | "dp";
    }

    Hierarchy

    • ChartOptions
      • PsychartOptions
    Index

    Properties

    altitude colors dbMax dbMin dpMax flipGradients flipXY font legend lineHeight major padding regions resolution showUnits size unitSystem yAxis

    Properties

    altitude: number

    The altitude of measurements taken.

    colors: { axis: string; font: string; regionGradient: PaletteName }

    The default color settings for Psychart.

    Type Declaration

    • Readonlyaxis: string

      The axis color as a hex-code string.

    • Readonlyfont: string

      The font color as a hex-code string.

    • ReadonlyregionGradient: PaletteName

      Defines the palette name used for region coloring.

    dbMax: number

    The maximum value on the dry bulb axis.

    dbMin: number

    The minimum value on the dry bulb axis.

    dpMax: number

    The maximum value on the dew point axis.

    flipGradients: boolean

    Optinally reverse gradients, making more/less saturated points appear on opposite ends.

    flipXY: boolean

    Determine whether to render a Mollier diagram.

    font: { name: string; size: number }

    The font used in this chart.

    Type Declaration

    • Readonlyname: string

      The name of the font family.

    • Readonlysize: number

      The size of the font, in pixels.

    legend: false | { margin: Point; size: Point; title: string }

    Styling options for the legend. If set to false, will not render a legend on Psychart.

    Type Declaration

    • false
    • { margin: Point; size: Point; title: string }
      • Readonlymargin: Point

        The margin between the top-left of the legend and the top-left of Psychart, in pixels.

      • Readonlysize: Point

        The size of the legend, in pixels. The scrollbar will be visible in the event of overflow.

      • Readonlytitle: string

        The title of the legend.

    lineHeight: number

    The spacing factor between entries in the legend, where 2.0 indicates double-spacing, for example.

    major: { humRat: number; relHum: number; temp: number }

    The major axis intervals for different units.

    Type Declaration

    • ReadonlyhumRat: number

      Humidity Ratio

    • ReadonlyrelHum: number

      Relative Humidity

    • Readonlytemp: number

      Temperature

    padding: Point

    The padding in pixels.

    regions: RegionName[]

    Render pre-defined shaded regions.

    resolution: number

    The chart resolution, in units.

    showUnits: { axis: boolean; tooltip: boolean }

    Determine where to show units.

    Type Declaration

    • Readonlyaxis: boolean

      Show units on the axes.

    • Readonlytooltip: boolean

      Show units on the tooltips.

    size: Point

    The outer size of this chart, in pixels.

    unitSystem: "IP" | "SI"

    Represents the unit system, in either US (IP) or metric (SI)

    yAxis: "hr" | "dp"

    Defines whether to use dew point or humidity ratio on the Y-axis.

    Settings

    Member Visibility

    On This Page

    Properties