Class Pumpchart

Show a pump's relationship between flow rate and pressure at different operating conditions.

Hierarchy

Chart<PumpchartTypes.Options>
- Pumpchart

Index

Constructors

Methods

clearData getElement plot getFlowUnits getHeadUnits getPowerUnits getSpeedUnits

Constructors

constructor

new Pumpchart(options?: Partial<PumpchartTypes.Options>): Pumpchart
Create a new Pumpchart with custom options.
Parameters
- options: Partial<PumpchartTypes.Options> = {}
  Customization options for the new Pumpchart.
Returns Pumpchart
Overrides Chart<Options>.constructor

Methods

clearData

clearData(): void
Clear all the data from this chart.

Returns void

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

plot

plot(
state: PumpchartTypes.State,
config?: Partial<PumpchartTypes.DataOptions>,
): void
Plot a single data point.
Parameters
- state: PumpchartTypes.State
  The current state of the system
- config: Partial<PumpchartTypes.DataOptions> = {}
  Display options for plotting data
Returns void

`Static`getFlowUnits

getFlowUnits(): Flow[]
Get the list of all available units for flow.

Returns Flow[]
A list of units

`Static`getHeadUnits

getHeadUnits(): Head[]
Get the list of all available units for head.

Returns Head[]
A list of units

`Static`getPowerUnits

getPowerUnits(): Power[]
Get the list of all available units for power.

Returns Power[]
A list of units

`Static`getSpeedUnits

getSpeedUnits(): Speed[]
Get the list of all available units for speed.

Returns Speed[]
A list of units