Ignition Perspective

https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective
Admin
Ignition Perspective is a next-generation mobile-responsive HMI/SCADA visualization system for...
Tokens:77,801
Snippets:610
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Custom Method Invocation Example

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

A concrete example of calling a custom method with string arguments.

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

```

--------------------------------

### Object Traversal Path Example

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/component-message-handlers

An example of a hard-coded component path using getSibling(). This approach is discouraged because it breaks if the component is renamed or moved to a different container.

```python
self.getSibling('Text Field').props.text
```

--------------------------------

### Getting the Page via getPage()

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Returns the page, similar to the .page property.

```python
self.getPage()
```

--------------------------------

### Bluetooth Advertising Data Example Output

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-session-events-scripts

Example of the data object structure received by the Bluetooth session event script, containing a list of buffered advertising data with RSSI, timestamps, and format-specific details.

```json
{
    "values":
        [
            {
                "rssi":-48,
                "timestamp":1570147485167,
                "manufacturerData":{
                    "companyId":6,
                    "dataBase64Encoded":"AQkgAl_edccdnHClMvecMCiM--aAkLHAPibd"
                }
            },
            {
                "rssi":-48,
                "timestamp":1570147486012,
                "serviceUUIDs":[
                    "FEAA"
                    ],
                "serviceData":{
                    "uuid":"FEAA",
                    "dataBase64Encoded":"AOyqqqqqqqqqqqqqAAAAAAAA"
                    },
                "eddystoneUID":{
                    "txPower":-20,
                    "namespaceID":"AAAAAAAAAAAAAAAAAAAA",
                    "instanceID":"000000000000"
                    }
            },
            {
                "rssi":-54,
                "timestamp":1570147485919,
                "manufacturerData":{
                    "companyId":76,
                    "dataBase64Encoded":"AhV88isfQjVLY4VnXXfYqpTyAAAAAL8="
                    },
                "iBeacon":{
                    "uuid":"7CF22B1F-4235-4B63-8567-5D77D8AA94F2",
                    "major":0,
                    "minor":0,
                    "txPower":-65
                    }
            },
            {
                "rssi":-54,
                "timestamp":1570147485987,
                "manufacturerData":{
                    "companyId":65535,
                    "dataBase64Encoded":"vqwSNFZ4EjQSNBI0EjRWeJASAAAAAOwA"
                    },
                "AltBeacon":{
                    "manufacturerId":65535,
                    "uuid":"12345678-1234-1234-1234-123456789012",
                    "instance":"00000000",
                    "txPower":-20,
                    "manufacturerReserved":"00"
                    }
            }
    ]
}
```

--------------------------------

### Indirect Tag Path Example

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/working-with-perspective-components/bindings-in-perspective/tag-bindings-in-perspective

Example of tag paths for motor folders used in an indirect binding configuration.

```text
Motors/Motor  1 /a mps  
Motors/Motor  2 /a mps  
Motors/Motor  3 /a mps  
Motors/Motor  4 /a mps  
```

--------------------------------

### Direct Tag Path Example

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/working-with-perspective-components/bindings-in-perspective/tag-bindings-in-perspective

A static tag path referencing a specific FlowRate tag within a valve folder.

```text
[default]MyPlant/EastArea/Valves/Valve4/FlowRate
```

--------------------------------

### Custom Method Implementation

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Example implementation of a custom method using two parameters to update component properties.

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

```

--------------------------------

### Style Editor Text Configuration

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/styles

Example of CSS properties configured within the Style Editor's Text menu.

```css
color: #800080
font-family: times
font-size: 19px
font-weight: bold
text-align: center
```

--------------------------------

### Custom Icon Repository XML

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/working-with-perspective-components/images-and-icons-in-perspective

An example of an SVG repository file named example.svg containing multiple icon definitions.

```xml
<?xml version="1.0" encoding="utf-8"?>  
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">    
  
    <!--a red circle-->  
    <svg viewBox="0 0 24 24" id="red-circle">  
        <circle cx="12" cy="12" r="6" stroke="black" stroke-width="1" fill="red" />   
    </svg>  
  
    <!--a blue circle-->  
    <svg viewBox="0 0 24 24" id="blue-circle">  
        <circle cx="12" cy="12" r="6" stroke="black" stroke-width="1" fill="blue" />   
    </svg>  
  
    <!--a triangle-->  
    <svg viewBox="0 0 24 24" id="triangle">  
        <path d="M12 0 L3 22 L21 22 Z" />  
    </svg>  
          
    <!--roman numeral one icon-->  
    <svg viewBox="0 0 24 24">  
        <g id="one">  
            <rect  
            id="rect3723" width="15.09025" height="3.0526078" x="4.4548745" y="2.4385488" />  
            <rect  
            id="rect3723-3" width="15.09025" height="3.0526078" x="4.4548745" y="19.510113"/>  
            <rect  
            id="rect3755" width="3.4557824" height="16.990929" x="10.272108" y="3.5045362" />  
        </g>  
    </svg>  
    <!--roman numeral two icon-->  
    <svg viewBox="0 0 24 24">  
        <g id="two">  
            <rect  
            id="rect3723" width="15.09025" height="3.0526078" x="4.4548745" y="2.4385488" />  
            <rect  
            id="rect3723-3" width="15.09025" height="3.0526078" x="4.4548745" y="19.510113" />  
            <rect  
            id="rect3755" width="3.4557824" height="16.990929"  x="6.8435426" y="3.5045362" />  
            <rect  
            id="rect3755-9" width="3.4557824" height="16.990929" x="13.700686" y="3.5045002"/>  
        </g>  
    </svg>     
</svg>
```

--------------------------------

### Image Management URL Example

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/working-with-perspective-components

The URL format for accessing images stored within the Gateway's Image Management system.

```text
http://gatewayIpAddress:8088/system/images/Builtin/icons/24/lightbulb_on.png
```

--------------------------------

### Startup Event Script

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-session-events-scripts

A Python script to be used in the Startup event to record the session opening time via a named query.

```python
# This script will record the time when the Session is opened.  
   
    # Create the parameters  
    queryParams = {'sessionID':session.props.id}  
   
    # Run the query  
    system.db.runNamedQuery('My Project', 'Startup Query', queryParams)  
```

--------------------------------

### Numeric Range to String Mapping with Omitted Values

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/working-with-perspective-components/bindings-in-perspective/transforms/map-transform

Example of mapping numeric ranges to strings where the start or end of the range is omitted.

```text
(,25]           "Below 25"  
(25,)           "Above 25"  
Fallback        "Invalid Value"  
```

--------------------------------

### Session .getProjectInfo() method

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Returns a dictionary of project metadata, available in version 8.1.4 and later.

```python
self.session.getProjectInfo()
```

--------------------------------

### Getting the Session via getSession()

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Returns the session, similar to the .session property.

```python
self.getSession()
```

--------------------------------

### Request Print with Targets

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Demonstrates printing specific targets including component, view, or page with a document title.

```python
self.requestPrint(target='component', documentTitle='MyTitle')  
self.requestPrint(target='view', documentTitle='MyTitle')  
self.requestPrint(target='page', documentTitle='MyTitle')  
```

--------------------------------

### Startup Query SQL

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-session-events-scripts

An update query to insert the session ID and current timestamp into the sessions table.

```sql
INSERT INTO sessions (session_id, start_time)  
VALUES (:SessionID, CURRENT_TIMESTAMP)  
```

--------------------------------

### Getting Parent Container via getParent()

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Functionally similar to the .parent property.

```python
self.getParent()
```

--------------------------------

### Getting Children Components via getChildren()

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Functionally similar to the .children property.

```python
self.getChildren()
```

--------------------------------

### Calling a Component Method

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Example of invoking a method defined on the 'self' component object.

```python
output = self.myMethod(param1,param2)
```

--------------------------------

### Getting the Parent View via getView()

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Returns the view, similar to the .view property.

```python
self.getView()
```

--------------------------------

### Getting a Sibling Component via getSibling()

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Returns a reference to an object in the same container as the source component.

```python
self.getSibling('Label')
```

--------------------------------

### UDT Definition and Instance JSON

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/working-with-perspective-components/bindings-in-perspective/tag-bindings-in-perspective/drop-configuration

This JSON structure defines the UDT type and instance required for the drop configuration example. Copy and paste this into your Tag Provider's folder.

```json
{
"name": "",
"tagType": "Provider",
"tags": [
    {
    "name": "UDT_Drop_Target",
    "tagType": "Folder",
    "tags": [
        {
        "name": "New Instance",
        "typeId": "UDT_Drop_Target/My_Type",
        "parameters": {
            "thing1": {
            "dataType": "String",
            "value": "Hello!"
            }
        },
        "tagType": "UdtInstance",
        "tags": [
            {
            "name": "Member_1",
            "tagType": "AtomicTag"
            },
            {
            "name": "Member_2",
            "tagType": "AtomicTag"
            }
        ]
        }
    ]
    },
    {
    "name": "_types_",
    "tagType": "Folder",
    "tags": [
        {
        "name": "UDT_Drop_Target",
        "tagType": "Folder",
        "tags": [
            {
            "name": "My_Type",
            "tagType": "UdtType",
            "tags": [
                {
                "valueSource": "memory",
                "name": "Member_2",
                "value": 123,
                "tagType": "AtomicTag"
                },
                {
                "valueSource": "expr",
                "expression": "\"Hello!\"",
                "dataType": "String",
                "name": "Member_1",
                "tagType": "AtomicTag"
                }
            ]
            }
        ]
        }
    ]
    }
]
}
```

--------------------------------

### Perspective Pipe JSON Structure

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/working-with-perspective-components/perspective-pipes

Example JSON structure defining a pipe with its origin, connections, and appearance properties.

```json
[
  {
    "name": "pipe",
    "appearance": "auto",
    "flanges": true,
    "lineVariant": "solid",
    "start": "none",
    "end": "none",
    "fill": "",
    "stroke": "",
    "width": 10,
    "origin": {
      "x": 258,
      "y": 168,
      "connections": [
        {
          "x": 258,
          "y": 236,
          "connections": [
            {
              "x": 307,
              "y": 236,
              "connections": [
                {
                  "x": 360,
                  "y": 236
                },
                {
                  "x": 307,
                  "y": 168
                }
              ]
            }
          ]
        }
      ]
    }
  }
]
```

--------------------------------

### Session.getProjectInfo()

Source: https://docs.inductiveautomation.com/docs/8.1/ignition-modules/perspective/scripting-in-perspective/perspective-component-methods

Returns metadata about the current project.

```APIDOC
## .getProjectInfo()

### Description
Returns a dictionary of project meta data, including name, title, description, lastModified, lastModifiedBy, views, and pageConfigs.
```
Tokens:
Raw