Interface PumpchartOptions

Configuration options for Pumpchart.

interface PumpchartOptions {
    axisColor: string;
    axisWidth: number;
    curve: { pump: string; system: string };
    font: { name: string; size: number };
    gradient: PaletteName;
    padding: Point;
    pumpCurveColor: string;
    size: Point;
    speed: { max: number; operation: number; steps: number[] };
    systemCuveColor: string;
    timestamp: { start: number; stop: number };
    units: { flow: string; head: string; power: string; speed: string };
}

Hierarchy

ChartOptions
- PumpchartOptions

Index

Properties

axisColor axisWidth curve font gradient padding pumpCurveColor size speed systemCuveColor timestamp units

Properties

`Readonly`axisColor

axisColor: string

The axis color (hexadecimal)

`Readonly`axisWidth

axisWidth: number

The axis thickness, in pixels

`Readonly`curve

curve: { pump: string; system: string }

Defines the curves to render on Pumpchart h = f(q) using q as the function variable

Type Declaration

Readonlypump: string
The pump performance curve at 100% pump speed
Readonlysystem: string
The system curve

`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`padding

padding: Point

The padding of Pumpchart, in pixels.

`Readonly`pumpCurveColor

pumpCurveColor: string

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

`Readonly`size

size: Point

The outer size of this chart, in pixels.

`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`systemCuveColor

systemCuveColor: string

The hexadecimal color code for the system curve

`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: string; head: string; power: string; speed: string }

Units for various quantities

Type Declaration

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

Interface PumpchartOptions

Hierarchy

Index

Properties

Properties

`Readonly`axisColor

`Readonly`axisWidth

`Readonly`curve

Type Declaration

`Readonly`pump: string

`Readonly`system: string

`Readonly`font

Type Declaration

`Readonly`name: string

`Readonly`size: number

`Readonly`gradient

`Readonly`padding

`Readonly`pumpCurveColor

`Readonly`size

`Readonly`speed

Type Declaration

`Readonly`max: number

`Readonly`operation: number

`Readonly`steps: number[]

`Readonly`systemCuveColor

`Readonly`timestamp

Type Declaration

`Readonly`start: number

`Readonly`stop: number

`Readonly`units

Type Declaration

`Readonly`flow: string

`Readonly`head: string

`Readonly`power: string

`Readonly`speed: string

Settings

On This Page

Interface PumpchartOptions

Hierarchy

Index

Properties

Properties

ReadonlyaxisColor

ReadonlyaxisWidth

Readonlycurve

Type Declaration

Readonlypump: string

Readonlysystem: string

Readonlyfont

Type Declaration

Readonlyname: string

Readonlysize: number

Readonlygradient

Readonlypadding

ReadonlypumpCurveColor

Readonlysize

Readonlyspeed

Type Declaration

Readonlymax: number

Readonlyoperation: number

Readonlysteps: number[]

ReadonlysystemCuveColor

Readonlytimestamp

Type Declaration

Readonlystart: number

Readonlystop: number

Readonlyunits

Type Declaration

Readonlyflow: string

Readonlyhead: string

Readonlypower: string

Readonlyspeed: string

Settings

On This Page

`Readonly`axisColor

`Readonly`axisWidth

`Readonly`curve

`Readonly`pump: string

`Readonly`system: string

`Readonly`font

`Readonly`name: string

`Readonly`size: number

`Readonly`gradient

`Readonly`padding

`Readonly`pumpCurveColor

`Readonly`size

`Readonly`speed

`Readonly`max: number

`Readonly`operation: number

`Readonly`steps: number[]

`Readonly`systemCuveColor

`Readonly`timestamp

`Readonly`start: number

`Readonly`stop: number

`Readonly`units

`Readonly`flow: string

`Readonly`head: string

`Readonly`power: string

`Readonly`speed: string