---
title: "Perspective - Pump"
description: "An animated component that looks like a pump."
---

# Perspective - Pump

> An animated component that looks like a pump.

![](MBFA02u.gif)

**Component Palette Icon:**

![](2020-09-01_17-21-57.png)

An animated component that looks like a pump. Full menu of [style options](appendix\reference-pages\style-reference.md) is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a [style class](ignition-modules\perspective\styles\style-classes\style-classes.md). The Pump has two pre-configured [variants](ignition-modules/perspective/working-with-perspective-components/working-with-perspective-components.md):

- **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](ignition-modules\perspective\working-with-perspective-components\bindings-in-perspective\bindings-in-perspective.md).
This section only documents the Props Category of properties. The other Categories are described on the [Perspective Component Properties](ignition-modules\perspective\working-with-perspective-components\perspective-component-properties.md) page.

| Name           | Description     | Property 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](ignition-modules/perspective/perspective-sessions/session-properties.md) symbols.autoAppearance. ![](2020-09-02_14-04-06.png) | 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 Property](ignition-modules/perspective/perspective-sessions/session-properties.md).   | value: numeric |
| state          | State of the animation. Built-in options are default, running, stopped, or faulted. Default is default. Built-in states and new states can be configured and applied on the [Project Properties > Symbols](ignition-modules/perspective/perspective-project-properties.md#perspective-symbols-properties) page. | value: string  |
| orientation    | Orientation of the pump. Options are top, bottom, left, or right. Default is right.  | color          |
| feet | Feet location for the pump. Options are top, bottom, left, or right. Default is bottom.     |                |
| label  | Label settings for the component.**text**: Text for the label. Value is string.**location**: Label position relative to the pump: top, bottom, left, right, or hidden. Default is bottom. Value is string.**justify**: Label text justification: left, center, right, or auto. Default is center. Value is string.**style**: Modify label text style using the style properties. Full menu of [style options](appendix\reference-pages\style-reference.md) is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a [style class](ignition-modules\perspective\styles\style-classes\style-classes.md)| object         |
| value          | Value settings for the component. **text**: Value to display as text. Value is string.**location**: Value position relative to the pump: top, bottom, left, right, or hidden. Default is bottom. Value is string.**justify**: Value text justification: left, center, right, or auto. Default is center. Value is string.**style**: Sets a style for the value Full menu of [style options](appendix\reference-pages\style-reference.md) is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a [style class](ignition-modules\perspective\styles\style-classes\style-classes.md) | object         |
| style          | Sets a style for this cylindrical tank. Full menu of [style options](appendix\reference-pages\style-reference.md) is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a [style class](ignition-modules\perspective\styles\style-classes\style-classes.md).  The Pump has two pre-configured [variants](ignition-modules/perspective/working-with-perspective-components/working-with-perspective-components.md). | object         |

## Component Events

The [Perspective Event Types Reference](appendix/reference-pages/perspective-event-types-reference.md) page describes all the possible component event types for Perspective components. Not all component events support each Perspective component. The [Component Events and Actions](ignition-modules/perspective/working-with-perspective-components/component-events-and-actions.md) 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

![](2020-09-02_14-13-30.png)

|Property|Value|
|--|--|
|props.appearance| simple|
|props.variant |vacuum|
|props.label.text| Vacuum Pump Simple|
|props.style.backgroundColor |#CCCCFF|
|props.style.borderStyle|solid|