Interface Options

Configuration options for Pumpchart.

interface Options {
    axisColor: string;
    axisWidth: number;
    colorizeBy: "time" | "none" | "efficiency";
    curve: {
        pump: { maxFlow: number; maxHead: number };
        system: { friction: number; static: number };
    };
    flipGradient: boolean;
    font: { name: string; size: number };
    gradient: PaletteName;
    highlightColor: string;
    padding: PsychartTypes.Point;
    pumpCurveColor: string;
    size: PsychartTypes.Point;
    specificGravity: number;
    speed: { max: number; operation: number; steps: number[] };
    systemCurveColor: string;
    textColor: string;
    timestamp: { start: number; stop: number };
    units: { flow: Flow; head: Head; power: Power; speed: Speed };
}

Hierarchy

ChartOptions
- Options

Index

Properties

axisColor axisWidth colorizeBy curve flipGradient font gradient highlightColor padding pumpCurveColor size specificGravity speed systemCurveColor textColor timestamp units

Properties

`Readonly`axisColor

axisColor: string

The hexadecimal color code for the chart axes

`Readonly`axisWidth

axisWidth: number

The axis thickness, in pixels

`Readonly`colorizeBy

colorizeBy: "time" | "none" | "efficiency"

Determine how to colorize data points with the gradient

`Readonly`curve

curve: {
pump: { maxFlow: number; maxHead: number };
system: { friction: number; static: number };
}

Defines the curve parameters to render on Pumpchart

Type Declaration

Readonlypump: { maxFlow: number; maxHead: number }
The pump performance curve parameters at 100% pump speed
- ReadonlymaxFlow: number
  The maximum flow rate at zero head
- ReadonlymaxHead: number
  The maximum head at zero flow (shut-off head)
Readonlysystem: { friction: number; static: number }
The system curve parameters: sys(q) = static + friction * q^2
- Readonlyfriction: number
  The coefficient of friction (dynamic head loss) of the system
- Readonlystatic: number
  Static head loss in the system, which is defined by the elevation difference between the inlet and outlet of the system, and is theoretically zero for closed systems

`Readonly`flipGradient

flipGradient: boolean

Determine whether to flip the gradient

`Readonly`font

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.

`Readonly`gradient

gradient: PaletteName

The gradient name for plotting time-series data

`Readonly`highlightColor

highlightColor: string

The hexadecimal color code for data highlighting on click

`Readonly`padding

padding: PsychartTypes.Point

The padding of Pumpchart, in pixels.

`Readonly`pumpCurveColor

pumpCurveColor: string

The hexadecimal color code for the pump performance curve(s)

`Readonly`size

size: PsychartTypes.Point

The outer size of this chart, in pixels.

`Readonly`specificGravity

specificGravity: number

The specific gravity of the process fluid used in the system (relative to pure water, at 1g/cm3)

`Readonly`speed

speed: { max: number; operation: number; steps: number[] }

Values for speed in the units specified, used to generate pump performance curves

Type Declaration

Readonlymax: number
The maximum pump speed
Readonlyoperation: number
The speed of optimal operation
Readonlysteps: number[]
The intermediate performance curves to generate for different pump speeds

`Readonly`systemCurveColor

systemCurveColor: string

The hexadecimal color code for the system curve

`Readonly`textColor

textColor: string

The hexadecimal color code for the axes labels

`Readonly`timestamp

timestamp: { start: number; stop: number }

Timestamps for colorizing time-series data

Type Declaration

Readonlystart: number
The starting timestamp
Readonlystop: number
The ending timestamp

`Readonly`units

units: { flow: Flow; head: Head; power: Power; speed: Speed }

Units for various quantities

Type Declaration

Readonlyflow: Flow
Flow rate (e.g. gpm)
Readonlyhead: Head
Head pressure (e.g. ft)
Readonlypower: Power
Pump power (e.g. kW)
Readonlyspeed: Speed
Pump speed (e.g. rpm)

Interface Options

Hierarchy

Index

Properties

Properties

ReadonlyaxisColor

ReadonlyaxisWidth

ReadonlycolorizeBy

Readonlycurve

Type Declaration

Readonlypump: { maxFlow: number; maxHead: number }

ReadonlymaxFlow: number

ReadonlymaxHead: number

Readonlysystem: { friction: number; static: number }

Readonlyfriction: number

Readonlystatic: number

ReadonlyflipGradient

Readonlyfont

Type Declaration

Readonlyname: string

Readonlysize: number

Readonlygradient

ReadonlyhighlightColor

Readonlypadding

ReadonlypumpCurveColor

Readonlysize

ReadonlyspecificGravity

Readonlyspeed

Type Declaration

Readonlymax: number

Readonlyoperation: number

Readonlysteps: number[]

ReadonlysystemCurveColor

ReadonlytextColor

Readonlytimestamp

Type Declaration

Readonlystart: number

Readonlystop: number

Readonlyunits

Type Declaration

Readonlyflow: Flow

Readonlyhead: Head

Readonlypower: Power

Readonlyspeed: Speed

Settings

On This Page

`Readonly`axisColor

`Readonly`axisWidth

`Readonly`colorizeBy

`Readonly`curve

`Readonly`pump: { maxFlow: number; maxHead: number }

`Readonly`maxFlow: number

`Readonly`maxHead: number

`Readonly`system: { friction: number; static: number }

`Readonly`friction: number

`Readonly`static: number

`Readonly`flipGradient

`Readonly`font

`Readonly`name: string

`Readonly`size: number

`Readonly`gradient

`Readonly`highlightColor

`Readonly`padding

`Readonly`pumpCurveColor

`Readonly`size

`Readonly`specificGravity

`Readonly`speed

`Readonly`max: number

`Readonly`operation: number

`Readonly`steps: number[]

`Readonly`systemCurveColor

`Readonly`textColor

`Readonly`timestamp

`Readonly`start: number

`Readonly`stop: number

`Readonly`units

`Readonly`flow: Flow

`Readonly`head: Head

`Readonly`power: Power

`Readonly`speed: Speed