Component Palette Icon:




On this page ...





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


The Split container holds two children separated by a draggable "split" that allows the user to resize the two children during the runtime. The Split container supports both horizontal and vertical layouts.

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
orientationThe orientation in which the container's split is fixed. Horizontal will allow the user to adjust the container from left to right, while Vertical will allow the user to adjust it from top to bottom.value: numeric
split

Configuration for the split bar.

NameDescriptionProperty Type
positionBidirectionally represents the position of the split bar. Numeric values here will be used as pixels.value: numeric or string
sizeThe size of the split bar in pixels.value: numeric
visibleDetermines if the split bar should be visible.value: boolean
draggableDetermines if the split bar should be draggable.value: boolean
object
styleUse Style to customize the visual style of the component. The Style menu contains all the tools for modifying text, background, margins, and borders. 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.

This event is fired when the split reaches the minimum bound on the container. For example, when the split bar's position reaches 0 px or 0% of the container's width.


Note: This component event is designed to be used in tandem with a script runAction. Within the script action, special properties and methods are available on the event object, which is passed to the script action as a parameter.

This event is fired when the split reaches the maximum bound on the container. For example, when the split bar's position reaches 100% of the container's width.


Note: This component event is designed to be used in tandem with a script runAction. Within the script action, special properties and methods are available on the event object, which is passed to the script action as a parameter.

Child Component Position Properties

When a component is placed inside of a Split container, it will inherit the position property listed below. 

PropertyDescriptionData Type
positionIndicates which side of the split bar the child component is located on. Expected values include "left", "right", "top", and "bottom" value: string

Scripting Functions

  • Description

Returns an ArrayList, which contains references to all components inside of the container.

  • Parameters

none

  • Return

Array List - An ArrayList of components in the container. The resulting ArrayList can be iterated over via a for-loop.



  • No labels