Chat now with support
Chat with Support

Foglight 7.1.0 - Web Component Tutorial

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

Additional Context for a View

Additional Context for a view allows you to supply additional information that your view can use inside its configuration or additionally, if it is a container view, for use by its children.

If you know that you are going to refer to a particular child of an existing context key often, you can create a new key that shortcuts the reference. For example:

agent = <host>/agent, where host is an object that has a property called agent.

This is also useful if you are building a container view and want to include children that require particular keys that are not explicitly present. Example: the child view has a key called host, but your parent view uses selectedHost. Solution: in additional context, map host to selectedHost. This section needs work. Find out what “a particular child of an existing context key” is, and what is meant by keys that are not explicitly present. The text above comes from the Wiki.

The key used to reference the object in other dialog boxes or scripts.

A more descriptive name for the key.

A Boolean value. If this check box is cleared, the key is evaluated each time the page is rendered. This is useful if the key is set to a binding whose value changes dynamically. If the box is checked, the key is evaluated when the page is created, but never after that. This is useful if the key is set to a static value or if reevaluating the key would cause errors. For example, if the key is used to create a new writable data object that should persist across multiple references to the page. If Evaluate Once is false, a new writable data object would be created each time the page is referenced.

The value is set using the binding editor. It can be a static value or a binding.

Additional Context for an Instance

When adding a view to a container view, it sometimes happens that the available context does not have the right information for the view that you want to include. In this case, it is possible in the container view to selectively create the right context. This is called additional context for an instance or instance context. The context is for that particular instance of the view and is not available when you use the view somewhere else. It would be more useful to show where to set the additional context, and to give an illustrative example.

The strongly typed, case insensitive string that references a particular context element. Type checking is done at design time.

The value stored in the context element, which can be either a static value or a binding.

Additional Context for a Flow

The progression from one view to another is called a flow. How the new view is made to appear depends on the flow action. The types of flow actions are described in Flow Types .

Often these views may have input requirements that exceed what is available in the context of the component from which you are coming. In this case, it is possible to define further Additional Context that applies to the flow. An illustrative example would be good here too.

Dynamic Context

Dynamic context keys are supplied by the component itself, and the value usually depends on some action taken by the end user. Dynamic context is only available for some components, such as Bar or Pie Chart, Cluster Bar Chart, Time Bar Chart, Time Plot Chart, Drop-Down List, Filter, Radio Button List, Row-Oriented Table, Tree Table, and Topology. The value of a dynamic context item changes depending on what is being rendered at the time, such as a row in a Row-Oriented table, or what is being selected, such as an item in a list. For example, in the Row-Oriented Table the dynamic context key current Row is available. When a row is processed for display, that row’s current Row value changes depending on which row is currently being rendered. Similarly, when an action is defined for row selection on a table, the selected row’s current Row value can be passed to the target of the action.

Dynamic context keys are not taken into consideration when the tree of views available for next page or popup flow types are filtered. Thus, they are essentially not available to be used as inputs for other views, they are just available for internal references when a view is being rendered.

Examples of dynamic context keys are:

Bar Gauge

Cluster Bar Chart

Drop-Down List, Filter

Row-Oriented Table


There are other components that have properties associated with dynamic context keys. See the Web Component Reference pages for details.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating