The following feature is new in Ignition version 8.1.0
Click here to check out the other new features

Component Palette Icon:

On this page ...


An animated component that looks like a pump.   Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.  The Pump has two pre-configured variants:

  • Centrifugal - Component appearance is that of a centrifugal pump.
  • Vacuum - Component appearance is that of a vacuum pump.


Properties

Most Properties have binding options. For more information on Bindings, see Types of Bindings in Perspective.
This section only documents the Props Category of properties. The other Categories are described on the Perspective Component Properties page.

NameDescriptionProperty Type
appearance

Options for the appearance of the component. Options are auto, p&id, mimic, and simple.

If set to auto, the value is taken from the Perspective Session Property symbols.autoAppearance. 

value: string
variant

Variant of pump to display. Options are centrifugal or vacuum. Default is centrifugal.  

value: string
animationSpeed

The speed of the animation as a percent. Set to "0" to turn off animation. 

If set to auto, then the animationSpeed setting is taken from the Perspective Session Properties.

value: numeric
state

State of the animation. Built-in options are default, running, stopped, or faulted. Default is default.

The following feature is new in Ignition version 8.1.26
Click here to check out the other new features
Built-in states and new states can be configured and applied on the Project Properties > Symbols page.

value: string
orientationOrientation of the pump. Options are top, bottom, left, or right. Default is right.color
feetFeet location for the pump. Options are top, bottom, left, or right. Default is bottom.
label

Label settings for the component. 

NameDescriptionProperty Type
textText for the label.value: string
locationLabel position relative to the pump: top, bottom, left, right, or hidden. Default is bottom.value: string
justifyLabel text justification: center, left or right. Default is center.value: string
style

Modify label text style using the style properties. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

object
object
value

Value settings for the component. 

NameDescriptionProperty Type
textValue to display as text.value: numeric
locationValue location relative to the pump: top, bottom, left, right, or hidden. Default is bottom.value: string
justifyValue text justification: center, left, or right. Default is center.value: string
style

Sets a style for the value. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

object
object
style

Sets a style for this cylindrical tank. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

object


Component Events

Perspective Component Events
The Perspective Event Types Reference page describes all the possible component event types for Perspective components. Not all component events support each Perspective component. The Component Events and Actions page shows how to configure events and actions on a Perspective component. Component scripting is handled separately and can be accessed from the Component menubar or by right clicking on the component.


Example

PropertyValue
props.appearancesimple
props.variantvacuum
props.label.textVacuum Pump Simple
props.style.backgroundColor#CCCCFF
props.style.borderStylesolid


  • No labels