Column Renderers and Formats
The following table lists the following information for each renderer that is supported by the advanced grids:
• Supported formats that you can select or specify for each renderer.
• Whether the renderer type supports editing at run time when editing for the grid is enabled. Run time editing is used to retrieve input from a user.
• Additional notes related to the functionally of some renderers.
|
Renderer Type
|
Formats
|
Run Time Editing
|
Notes
|
||
|---|---|---|---|---|---|
|
Default
|
N/A
|
N/A
|
Renders the data as a string when possible.
|
||
|
Number
|
Select or enter a string containing the format to use.
|
Yes
|
JSON configuration service – Formats support both % and $
Mashup builder – formats only support $.
Both support decimals.
|
||
|
Long
|
Select or enter a string containing the format to use.
|
Yes
|
JSON configuration service – Formats support both % and $
Mashup builder – Formats only support $.
Both support decimals.
|
||
|
HTML
|
• raw – The actual HTML is displayed in the grid cell.
• format – The HTML is encoded, XSS sanitized, and interpreted by the browser for display.
• unsanitized – The HTML is encoded but is NOT XSS sanitized before it is interpreted by the browser for display.
|
Yes
|
The format options listed in the column to the left are for JSON use. In the Mashup Builder, these options are labeled:
• Raw (no formatting)
• With Formatting
• With Formatting, Unsanitized (not-secure)
|
||
|
Hyperlink
|
• _blank – The navigation target is a new window or browser tab (depending on the browser).
• _self – The navigation target is the current window or tab.
• _parent – The navigation target is the parent of the iframe.
• _top – The navigation target is the top frame.
|
Yes
|
When selecting hyperlink renderer, a Link Text column is also available. Enter the text to be displayed by the link.
The following is a JSON example for configuring a hyperlink column:
“columnFormatter”: {
“type”: “hyperlink”,
“format”: “_blank”,
“params”: {
“textFormat”: “Click here!”
}
}
|
||
|
Imagelink
|
The path to an image file in a ThingWorx repository.
• image – Displays the image at its actual size.
• scaledtowidth – Scales the image to fit the column width.
• scaledtoheight – Scales the image to fit the row height.
• hyperlink – Displays a link to click, to view the image.
|
Yes
|
|||
|
String
|
• full – Displays the entire text string.
• notext – Displays no text.
• limitN – Limits the display of text to the first N characters. Limits are usually unnecessary when using data overflow options.
|
Yes
|
|||
|
Boolean
|
• checkbox – Displays a view-only check box in the grid cell.
• text – Displays text options such as true or false.
• notext – Displays no data. Use for state formatting only.
|
Yes
|
|||
|
Datetime
|
Follow the links on the right for more information about using the MomentJS and jdate formats.
|
Yes
|
For more information, see the following:
|
||
|
Integer
|
Select or enter a string containing the format to use.
|
Yes
|
JSON configuration service – formats support both % and $
Mashup builder – formats only support $.
Integer does not support decimals.
|
||
|
Location
|
Select or enter a string containing the latitude, longitude, or elevation format to identify a location. The format string can be used to truncate the precision of the latitude, longitude, and elevation values. When truncated, the values are rounded up. If no elevation value is included, it will be omitted from the output string.
|
Yes
|
An icon can be displayed with the location by using a state definition. Configure the state to define when to show the icon, depending on the value of the location string.
The following is a JSON example for configuring a location column:
“columnFormatter”: {
“type”: “location”,
“format”: “0.000000”,
}
}
|
||
|
Image
|
• image – Displays the image at its actual size.
• scaledtowidth – Scales the image to fit the column width.
• scaledtoheight – Scales the image to fit the row height.
• hyperlink – Displays a link to click, to view the image.
|
No
|
The IMAGE renderer does not support editing at run time and you cannot retrieve image changes as input from a user. To enable image editing, use the IMAGELINK renderer and make sure that the infotable column contains links to images in a ThingWorx repository.
|
||
|
Infotable
|
Formats the ThingWorx data structure used to store results of a service or a set of properties for a Thing.
|
No
|
|||
|
JSON
|
Formats data containing JavaScript Object Notation (JSON) objects.
|
No
|
|||
|
Mashups
|
Formats references to a ThingWorx mashup.
• Text only—Displays the entity name as text.
• _blank – The navigation target is a new window or browser tab (depending on the browser).
• _self – The navigation target is the current window or tab.
• _parent – The navigation target is the parent of the iframe.
• _top – The navigation target is the top frame.
|
No
|
|||
|
Password
|
Formats data values by masking characters. Use this to hide sensitive information.
|
No
|
|||
|
Tags
|
Formats tags of model entities.
Type of tags and formatting data, model or plain
Data Tags
Model Tags
No Hyperlinks
|
No
|
|||
|
Thingcode
|
Formats the numeric representation of a Thing, containing a Domain ID and an Instance ID.
|
Yes
|
|||
|
• Thingname
• Thingshape
• Thingtemplatename
• Username
|
Enables you to choose how references to entity names are formatted. You can show plain text or a link.
• Text only—Displays the entity name as text.
• _blank – The navigation target is a new window or browser tab (depending on the browser).
• _self – The navigation target is the current window or tab.
• _parent – The navigation target is the parent of the iframe.
• _top – The navigation target is the top frame.
|
No
|
|||
|
• VEC2
• VEC3
• VEC4
|
Formats vector base types that have two, three, or four decimal values modeled with x, y, z, and w variables.
|
Yes
|
|||
|
XML
|
Formats XML data.
|
No
|
 |
• Rendering with dynamic Data Shapes is supported when you provide dynamic configuration. When data in Advanced Grid is populated using dynamic Data Shapes, provide configuration at run time to render the values as expected. Configuration can be provided using a service that is bound to Configuration of Advanced Grid. This service is like the one which provides data based on data shape name.
|