Perspective Component Methods

Autocomplete

To disable this feature, right-click anywhere within the Script Editor window and deselect Automatic Activation.

Object Traversal

In most Perspective scripts, you are given a reference to a component object (often in the form of a self parameter). The object is given in component scripts, but has several methods and properties associated with it to help traverse to the other objects in a Perspective View or get values from the Session.

Object Traversal is limited to a single view. If a script needs to reference a component in a different view, or there is a possibility that the hierarchy of the view will change, then Message Handling should be utilized instead.

self.children

self.getChildren()

self.parent

self.getParent()

self.getChild('Label_0')
self.getChild('Container/Label_0')

self.getSibling('Label')

self.view

self.getView()

page     = self.page
pageID   = page.props.pageId
pagePath = page.props.path

self.getPage()

session = self.session
sesName = session.props.gateway.address
sesProp = session.custom.propertyName

self.getSession()

session = self.getSession()
session.close("The session has now closed")

self.session.getInfo()["pageIds"]

self.session.getPages()

self.session.getPage("2b2eb647")

self.session.getProjectInfo()

view.rootContainer

view.id

session = view.session
sesName = session.gateway.address
sesProp = session.custom.propertyName

Object Traversal Examples

If you want to get other component properties in a view while scripting, you can use the above methods and properties to move around the View.

These examples assume you have the following structure/components in a View:

• View
  • Button 1
  • Text Field 1
  • Container 2
    • Text Field 2
  • Container 3
    • Text Field 3
    • Container 4
      • Button 4
      • Text Field 4

# this example code exists on the 'Button 1' in the above hierarchy. 

# get to the view that the button is in
view = self.view

# get the text from 'Text Field 1'
text1 = self.getSibling('Text Field 1').props.text

# get the text from 'Text Field 2'
text2 = self.getSibling('Container 2').getChild('Text Field 2').props.text

# get the text from 'Text Field 3'
text3 = self.getSibling('Container 3').getChild('Text Field 3').props.text

# get the text from 'Text Field 4'. Either of these will work the same.
text4 = self.getSibling('Container 3').getChild('Container 4/Text Field 4').props.text
text4 = self.getSibling('Container 3').getChild('Container 4').getChild('Text Field 4').props.text

# this example code exists on the 'Button 4' in the above hierarchy. 

# get to the view that the button is in
view = self.view

# get the text from 'Text Field 1'
text1 = self.parent.parent.getSibling('Text Field 1').props.text

# get the text from 'Text Field 2'
text2 = self.parent.parent.getSibling('Container 2').getChild('Text Field 2').props.text

# get the text from 'Text Field 3'
text3 = self.parent.getSibling('Text Field 3').props.text

# get the text from 'Text Field 4'
text4 = self.getSibling('Text Field 4').props.text

Built-In Methods

Perspective components contain several shared methods. This section details such methods. Some methods are only available to certain types of components. In these cases, the description for the method will state any limitations. 

Refreshing Bindings

The refreshBinding function can be used to manually fire a binding, and is designed to be used on bindings that can poll (like query and Tag history bindings). In these instances, using refreshBinding in lieu of polling can save Gateway resources. The refreshBinding() function takes a string as a parameter, corresponding to the property that should be refreshed:

self.refreshBinding("props.data")

It is often useful to use refreshBinding() from a component message handler, since we can then refresh several applicable bindings via a single system.perspective.sendMessage call.

Requesting Focus

The focus method can be called by a component to request focus in a view. This is useful if you wish to control where keyboard input is directed after a particular action. 

Due to the nature of focus, calling the focus method is only effective on components that can have focus. Input components such as the Text Field and Numeric Entry Field components can gain focus, but Display components like Labels and Images can not gain focus. 

self.focus()

Requesting or Removing Tooltips

You may call these functions for any component with meta tooltips enabled. Requesting a tooltip will have no effect if tooltips are not enabled for the component. 

self.requestTooltip()
self.removeTooltip()

# enable and then call tooltip for 'Label 1' in the same view
self.getSibling('Label 1').meta.tooltip.enabled = True
self.getSibling('Label 1').requestTooltip()

Custom Methods

Perspective offers the option of configuring your own methods for a component. To configure a custom method:

1. Right-click on the desired component in the Designer, and select Configure Scripts...
   
   
2. Under Custom Methods, double click on Add method...
3. Enter a Name for your method, which will be used to call the method. We used myMethod in this example.
4. Enter any number of Parameters your method will need, separated by commas. For this instance, we have two parameters: myParam1 and myParam2.

5. Add code to implement your method. 

   self.props.text = myParam1
   self.custom.myProp = myParam2

   Note: A self object is provided in every custom method, but should not be provided as a parameter when calling the function.

   
   
   
   

6. Click OK to commit your method.

7. To call this method, use:

   self.myMethod(param1,param2)

   For example:

   self.myMethod("Hi!","This is a test")