Skip to end of metadata
Go to start of metadata
General

Component Palette Icon:



Description

A Checkbox is a familiar component that represents a bit - it is either on (selected) or off (not selected). In addition, the 'triState' property can be enabled, adding a third state to represent an indeterminate value. It is functionally equivalent to the Toggle Switch component.

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

The Checkbox component has two pre-configured variants: Text Right and Text left.

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
selectedOutput value for checkbox.value: boolean
textLabel for the checkbox.value: string
textPositionWhere to place the label text in relation to the checkbox: top, right, bottom, or left.value: string 
enabled

Whether the user can currently interact with the checkbox.

Note: If the component is disabled, scripts can still run on the component. For example, if you add a script action to the onClick event, the script will fire when the user clicks on the Checkbox.

value: boolean
triStateWhether the checkbox supports a third state of "indeterminate" - effectively 'null' or 'no choice'.value: boolean
checkedIcon

Settings for the appearance of the check box's icon when it is selected (checked).

NameDescriptionProperty Type
pathPath to the icon source, in format: library/IconName. For more information on icons, see the Images, SVGs, and Icons in Perspective page. value: string
color

Settings for the fill color for the checked icon.

NameDescriptionProperty Type
enabledColor of the icon when enabled. Can be a named color.value: string
disabledColor of the icon when disabled. Can be a named color.value: string
object
styleSets a style for the icon.  Full menu of style options is available. You can also specify a style class.object
object
uncheckedIcon

Settings for the appearance of the check box's icon when it is not selected.

NameDescriptionProperty Type
pathPath to the icon source, in format: library/IconName. For more information on icons, see the Images, SVGs, and Icons in Perspective page. value: string
color

Settings for the fill color for the unchecked icon.

NameDescriptionProperty Type
enabledColor of the icon when enabled. Can be a named color.value: string
disabledColor of the icon when disabled. Can be a named color.value: string
object
styleSets a style for the icon. Full menu of style options is available. You can also specify a style class.object

Sets a style for this component. 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
indeterminateIcon

Settings for the appearance of the check box's icon when it is in the indeterminate state. Only applies if props.triState is set to true.

NameDescriptionProperty Type
pathPath to the icon source, in format: library/IconName. For more information on icons, see the Images, SVGs, and Icons in Perspective page. value: string
color

Settings for the fill color for the icon.

NameDescriptionProperty Type
enabledColor of the icon when enabled. Can be a named color.value: string
disabledColor of the icon when disabled. Can be a named color.value: string
object
styleSets a style for the icon. Full menu of style options is available. You can also specify a style class.object
object
style

Sets a style for this component. 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.

Examples
Example 1

PropertyValue
props.textCheckbox 1
props.textPositionleft
props.triStatetrue
Example 2

PropertyValue
props.textCheckbox 2
props.textPositionleft
props.selectednull
Example 3

PropertyValue
props.textCheckbox 3
props.textPositiontop
props.enabledfalse
props.selectedfalse


  • No labels