https://docs.optrix.com.au/ Wed, 27 May 2026 01:23:50 +0000 FeedCreator 1.8 https://docs.optrix.com.au/_media/wiki:dokuwiki.svg https://docs.optrix.com.au/ https://docs.optrix.com.au/interactivesvg:ardi_point_code ARDI Point Codes Each property in ARDI has a point code - a unique code that corresponds to the value inside the property. They are made up of three elements, separated by colons. [ASSET ID]:[PROPERTY ID]:[NODE NAME] Automatically Generating If your SVG file is uploaded to ARDI as a type of asset media, you can use anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:child CHILD_ Parameters Child Asset Name: A name (or part of a name) to search for in the assets that are located inside (within the Location relationship) of the Active Asset. Property Name: The name of the property on the child asset. Note that this is optional - if you don't include the property name, the ID of the child asset will be written into the space. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:connectto ConnectTo ConnectTo is a function of the HMIPanel class, used to connect to live data from an ARDI server. Before you call this function, you should have created one or more subscriptions with the Subscribe function first. Parameters Host: The path to the ARDI server. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:data-reactive_images Data-Responsive SVGs SVG (Scalable Vector Graphics) files are the web-standard for vector images. Unlike raster images (such as PNG, JPEG and GIF files), which have a fixed resolution and are based on pixels, vector images are based on shapes. Because of this, vector graphics can do a few things that raster images can't, such as anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:embed_code_reference Embed Code Reference Basic Codes CodeResultHOSTThe host name of the ARDI serverSITEThe url site code for the ARDI serverASSETIDThe numeric ID of the ARDI assetASSETNAMEThe name of the ARDI assetASSETERNThe Equipment Reference Number (or name, if none is available) of the ARDI asset anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:embedding_codes Embedding Codes When you add an SVG file to the media of one of your assets, ARDI will automatically check for embedding codes when users download the file. These codes make it possible for you to make a single SVG file that applies to a number of different assets. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:embedding_functions Embedding Functions There are also two functions created in any embedded SVG file, used to map values between their numeric and their text representations. For every property, you'll have a matching MapValueid and MapColourid function. So for property 11, you'll have a function named MapValue11 and MapColour11. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:example_of_a_standalone_svg_file Basic Standalone SVG File Digital signage SVG files use embedded Javascript code to make the SVG image respond to live data updates from ARDI. First, you prepare the image file in the vector image editor of your choice. For those with a limited budget, anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:gradient GRADIENT_ Used to get an array of colours and setpoints for use with the GradientColourRGB functioin. Parameters Property Name: The name of the property with a defined gradient. Example If you wanted to use the ARDI colour coding to respond to a value changing, you could use the following code anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:gradientcolourrgb GradientColourRGB This function takes a value, and an array of value-colour combinations (usually created from GRADIENT_). It returns a colour that smoothly interpolates between the various values, allowing you to smoothly transition between colours as the value animates. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:hmipanel HMIPanel The HMIPanel Javascript class is found in the /plugins/optrix/hmi.js file of your ARDI server. It contains the functions required to subscribe to live data from a web resource such as an HTML page or SVG file. Member Functions Subscribe UseSSL OnlyWhenFocused ConnectTo anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:next NEXT_ Used to get the asset ID of a the next (first downstream) asset from the Active Asset on a particular relationship. Parameters Relationship Name: The name of the relationship you want to use. Property Name: The optional name of the property you want to display. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:onlywhenfocused OnlyWhenFocused This is a member function of the HMIPanel class. This function sets up the ARDI API so that it disconnects when you change tabs or the active tab otherwise loses focus. This can prevent performance issues that can occur if you leave a page using the Javascript AI in the background for a long time. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:owning_asset Active Asset The Active Asset or owning asset in an embedded SVG is the asset that the media file has been downloaded from. For example, if you download the SVG file from asset 14, then asset 14 is the active asset. Note that when you add an SVG to a anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:prev PREV_ Used to get the asset ID of a the previous (first upstream) asset from the Active Asset on a particular relationship. Parameters Relationship Name: The name of the relationship you want to use. Property Name: The optional name of the property you want to display. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:px PX_ Used to get the point code of a named property on the active asset. Parameters Property Name: The name of the property on the owning asset. Example Let's assume you wanted to make an SVG file you could use for any machine with a 'Temperature' property. . You could use the following code anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:subscribe Subscribe The Subscribe function is part of the HMIPanel class in the ARDI Javascript API. You use the command to subscribe to changes in a single data point. Parameters Point: The point code for the property you want to monitor. Note that if you're creating a dynamic SVG file, you might be able to use an anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:usessl UseSSL The UseSSL function is part of the HMIPanel class in the ARDI Javascript API. You use the function before calling ConnectTo to force the system to use SSL when communicating with the ARDI server. This function normally isn't needed for any visualisation that will be hosted on the ARDI server - the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:using_the_api Using the API The Javascript web API is found in the /plugins/optrix/hmi.js file. Unlike the previous generation of the API (which had quite harsh transitions between values), the new API smoothly animates between values, and provides a number of additional helper functions to work with colour-gradients from ARDI. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/interactivesvg:welcome Javascript API & Data-Reactive Images The Javascript API can be used to retrieve live ARDI data from any browser-based platform. Apart from web pages, it's often used to create Data-Responsive SVGs. They key to the ARDI API is the HMIPanel class, which you use to subscribe to live data. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000