Icons: UpdateIconGlyphsUpdates the Glyphs of an existing Icon

Usage Notes

Glyphs are attributes of an icon which change depending on context. Examples are a "puff-of-smoke" will appear beside vehicles which are idling, and a directional arrow indication a vehicles heading while in motion. Other glyphs can be defined here.

The XmlGlyphs parameter takes an Xml node defining the glyphs being modified.

Each <add> and <remove> node specified must contain a valid condition attribute. For <add> nodes, the src, width, height, offsetx and offsety attributes must also exist.

Possible condition attribute values are:

motion
Special: the only attributes required are offsetx and offsety
mode#
Where # is a number between zero and six (0-6).
Shown when a device is flagged by our system in a specific mode.
di#on
Where # is a number between zero and five (0-5).
Shown when a device's Digital Input Wire # is on.
di#off
Where # is a number between zero and five (0-5).
Shown when a device's Digital Input Wire # is off.
ai#high
Where # is a number between zero and five (0-5).
Shown when a device's Analog Input Wire # is receiving more voltage than it should based on the behaviour profile.
ai#low
Where # is a number between zero and five (0-5).
Shown when a device's Analog Input Wire # is receiving less voltage than it should based on the behaviour profile.
do#on
Where # is a number between zero and five (1-4).
Shown when a device's Digital Output Wire # is outputting voltage.
do#off
Where # is a number between zero and five (1-4).
Shown when a device's Digital Output Wire # is not outputting voltage.
<glyphs>
<add condition="motion" width="#" height="#" offsetx="#" offsety="#" />
<add condition="ai0high" src="" width="#" height="#" offsetx="#" offsety="#" />
<remove condition="ai0low" />
</glyphs>

Example of Returned Data

<UpdateIconGlyphs Success="?" Message="" />

Test Method

ParameterValueTypeUsage
IconIDint32Unique icon identifier
XmlGlyphsstringSee Usage Notes.
An Xml node containing definition for icon glyphs