Perspective - Coordinate Container Scripting

This page details the various scripting, component, and extension functions available for Perspective's Coordinate Container component.

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.

onPipeClicked

This event will trigger when a pipe in this container is clicked.

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.

event.event

• Object Path

  • event.event

• Type

  • Dictionary

• Description

  • The event object generated from the mouse click.

event.pipeIndex

• Object Path

  • event.pipeIndex

• Type

  • Integer or float

• Description

  • The array index of the pipe within props.pipes that was clicked.

event.pipeName

• Object Path

  • event.pipeName

• Type

  • String

• Description

  • The name of the pipe that was clicked.

Component Functions

.getChildren()

• 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.

Extension Functions

This component does not have extension functions associated with it.