Skip to end of metadata
Go to start of metadata

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

General

Component Palette Icon:



Description

An animated component that looks like a tank or vessel. Options include displaying fill level, the stand, and the agitator.   Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

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

 Click here to see the appearance options

value: string
animationSpeed

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

 If set to auto, the setting is taken from the Perspective Session Property symbols.autoAnimationSpeed.

value: numeric
stateState of the animation. Option are default, running, stopped, or faulted. Default is default.  value: string
orientationOrientation of the vessel. Options are horizontal or vertical. Default is vertical.value: string
displayStandWhether or not to display the stand for the vessel. Default is true.value: boolean
displayAgitatorWhether or not to display the agitator in the vessel. Default is true.value: boolean
displayFillLevelWhether or not to display the fill level of liquid in the vessel. Default is true.value: boolean
liquidColorColor used to render the filled part of the vessel. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.color
liquidOpacityThe opacity of the liquid in the tank. 0 is fully transparent, 1 is fully opaque. Default is 0.7.value: numeric
liquidWarningColorThe warning color of the liquid in the tank. See Color Selector.color
label

Label settings for the component. 

 Click to see the label properties
NameDescriptionProperty Type
textText for the label.value: string
locationLabel location relative to the vessel: top, bottom, left, or right. 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. 

 Click to see the value properties
NameDescriptionProperty Type
displayValueAsPercentWhether or not to display the value as a percentage.value: boolean
valueText to display as value.value: string
capacityTotal capacity of the vessel. Default is 100.value: numeric
warningThreshold

The warning threshold indicates by turning a pale red when its reached or exceeded its set value. Default is 100.

value: numeric
locationValue location relative to the vessel: top, bottom, right, or left. 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

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.orientationhorizontal
props.displayStandtrue
props.liquidColor

#00ACAC

props.label.textLower Tank 23
props.label.locationbottom
props.label.style.fontWeightbold
props.label.style.color#804600
props.value.value35
props.value.capacity100
props.value.locationtop
props.value.style.color#00ACAC
props.value.style.fontFamilyRoboto
props.value.style.fontSize18
props.value.style.fontWeightbold


  • No labels