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 sensor.  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.value: string
orientationOrientation of the sensor. Options are top, bottom, left, or right. Default is right.value: string
reverseFlowWhether or not to reverse the direction of the flow. Default is false.value: boolean
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 sensor: top, bottom, left, right, or inside. Default is inside.value: string
justifyLabel text justification: center, left, right, or auto. Default is center. This property is only valid if props.label.location is set to top, bottom, left, or right.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
textValue to display as text.value: numeric
locationValue location relative to the vessel: top, bottom, right, left, or inside. Default is inside.value: string
justifyValue text justification: center, left, or right. Default is center.  This property is only valid if props.value.location is set to top, bottom, left, or right.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

There are no examples for this component.


  • No labels