gestaltpnid:gestalt_pnid:event_manager_reference
This is an old revision of the document!
Event Manager
Script Reference
Change Property
Changes the value of the specified property on a component to the specified value.
Method Signatures
changeProperty("[Component Id]", "[Property Name]", "[Property Value]")
| Parameter | Type | Description | Required? |
|---|---|---|---|
| Component Id | string | The id of the property you want to change a property of. | Yes |
| Property Name | string | The name of the property you would like to alter. | Yes |
| Property Value | any | The value to set the property to. | Yes |
Set Position
Changes the position of a component to the provided XY co-ordinate.
Method Signatures
setPosition("[Component Id]", "[X Position]", "[Y Position]")
| Parameter | Type | Description | Required? |
|---|---|---|---|
| Component Id | string | The id of the property you want to change the position of. | Yes |
| X Position | numeric | The x co-ordinate of the position to move the component to. | Yes |
| Property Value | numeric | The y co-ordinate of the position to move the component to. | Yes |
Set Query
Changes the query settings of the dashboard.
Method Signatures
setQuery("[Start Time]", "[End Time]", "[Interval]", "[Data Function]")
| Parameter | Type | Description | Required? |
|---|---|---|---|
| Start Time | string | The start date to set the query to, which can either be an absolute date in ISO format or a relative value e.g. *-10d, *-1h. | Yes |
| End Time | string | The end date to set the query to, which can either be an absolute date in ISO format or a relative value e.g. *, *-1h. | Yes |
| Interval | string | The interval to set the query to e.g. 1d, 1h, 1m. | Yes |
| Data Function | string | The data function to set the query to e.g. PLOT, MAX, MIN, INTERP, AVG or RAW | Yes |
Write Value
Writes a value to the snapshot of the specified tag.
Method Signatures
writeValue("[Datasource Name]", "[Tag Name]", "[Value To Write]", "[Note]", "[Success Callback]", "[Fail Callback]")
| Parameter | Type | Description | Required? |
|---|---|---|---|
| Data Source Name | string | The qualified data source name the tag belongs to. | Yes |
| Tag Name | string | The name of the tag the value is to be written to. | Yes |
| Value To Write | string/numeric | The value to be written to the tag. It can be a string value or a numeric value. | Yes |
| Note | string | A note to be attached to the value being written | No |
| Success Callback | function | Function that will be called when the write is successful. | No |
| Fail Callback | function | Function that will be called when the write fails. | No |
gestaltpnid/gestalt_pnid/event_manager_reference.1712926747.txt.gz · Last modified: 2024/04/12 12:59 by su