Chat now with support
Chat with Support

Foglight 5.9.1 - Web Component Guide

Introducing the Web Component Framework The Web Component Framework Configuring Views and Context Queries Functions Bindings Additional Components

Binding a property that takes a color or an image to data

Threshold Renderers are configured to provide a color or image (icon) associated with a particular data item. When they are passed a value they will specify a particular color or image, so you bind the property to the data and specify the appropriate renderer, which obtains the correct value for you.

 
* 
NOTE: If you have a requirement to use different renderers for different sorts of labels, say in table columns, you can use the table’s nested grouping feature. Since columns are independent of groups, you can assign a renderer to one column and a different renderer in another column. This avoids the complexity of having to use one renderer and parameterizing it, which may cause alignment problems in the table’s columns.

Input Value

The Web Component Framework supports the concept of an Input Value. This is the value to be rendered and is made available in the context under the key value.

If you edit a renderer that supports having an Input Value, on the General tab, you can specify the Value Data Source Type, Value Data Type, and Value List. These specify the expected data source type of the value, data object type, and whether the value will be a list. You can then refer to the Input Value via a Context Selection binding by setting the key of such to value and you can also use the context entry as the root of a path in order to access subproperties of that type.

Figure 51. Input values

For example, for a Date Renderer, if you set the Value Data Source Type to Monitoring and the Value Data Type to Alarm, then you can set the Date property to a Context Selection Binding with key=value, path=Created Time in order to render the Created Time of an alarm as a date.

The default value of Value Data Source Type and Value Data Type depend on the renderer component. The default value of Value List is false.

Determining the Appropriate Renderer for a Binding

Determining which renderer to use for a given binding involves several possibilities. The following list specifies the current possibilities, listed in priority order, which means if the first one does not apply, the second one is used, and so on.

•
If a specific renderer is configured for this binding (in the Renderer attribute of the binding editor), use that renderer.
•
If the value is a Web Component Framework Data Object, and a renderer is associated with its parent Type and containment Property (using the Child Property Mapping tab of the Type Mapping editor), use that renderer.
•
If the value is derived from a child property of a Metric Data Object, and is a Number, and a renderer is associated with the parent Type and containment Property of the Metric (using the Child Property Mapping tab of the Type Mapping editor), use that renderer.
•
If the value is a Web Component Framework Data Object, and a renderer is associated with its Type (using the Type Mapping editor), use that renderer.
•
If a renderer is associated with the unit of this object (via the Unit Mapping editor), use that renderer.
•
If none of the preceding rules apply, use the Default Renderer.

Type Mappings

Type mappings associate entities such as renderers, icons, and tagged flows to a specific data type or data type property. At runtime, Web Component Framework looks up the entities mapped to these types and properties to use as defaults if more specific entities have not been set.

If you configure a view’s flow with a flow type of Select type flow, the Web Component Framework looks in its type mappings at runtime for a flow associated with the type in question.

You can register different kinds of default flows by specifying tags. You can provide your own by typing its name into the tag name combo box, or choose one of the predefined tags:

•
drilldown: Used for a flow that takes you to a new page.
•
summary: Used to retrieve a view appropriate for a dwell.
•
menu: Used to retrieve a view that gives the user a list of options with a temporary popup.
•
dialog: Used to flow to a view that is sized to appear overtop of current data, either as a temporary or permanent popup as appropriate.
•
edit: Used to flow to the appropriate editor for the specified object.

At run-time, if no specific renderer has been specified on a binding, the Web Component Framework will look in the type mappings to see if a renderer has been mapped to the type of the data or the property the data was retrieved from. In the event of a conflict, renderers mapped to properties take precedence over renderers mapped to types.

When an Icon Renderer is explicitly specified as the renderer on a binding, the renderer looks in the type mappings to find the icon that has been mapped to the type of the data evaluated from the binding.

 
* 
NOTE: You can register a renderer for any child property. This renderer takes priority over a renderer that is registered to the particular type.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating