element <renderer>
Namespace: |
http://schema.caplin.com/CaplinTrader/rendererDefinitions |
XML Representation Summary |
||||||||||||
| <renderer | ||||||||||||
|
||||||||||||
| > | ||||||||||||
|
||||||||||||
| </renderer> | ||||||||||||
Child elements (4):
Parent elements (3):
Description
A <renderer> tag can specify three different kinds of renderer.
When it is the parent of a <control> tag, it defines a display control and the optional <upstream> and <downstream>
transforms that transform the data in the control.
When it is the parent of a <template> tag, it defines a composite renderer that is constructed
from other renderer definitions.
When it is the child of a <template> tag, it is part of a composite renderer and identifies the renderer of
a particular data stream.
A typical use of a composite renderer is to render data from multiple data streams
(such as 'bid' and 'ask' prices) in the column of a Grid.
-
Type:xs:string, predefinedUse:optionalThe name of the data stream that is rendered (for example, stream="bid"). This optional attribute is only required when the renderer is part of a composite renderer (a child of the <template> tag). The renderer of the named data stream is identified by the 'type' attribute (Second role).
-
Type:xs:string, predefinedUse:optionalA comma separated list of stream names (for example, streams="bid,ask"). This optional attribute is only required when the renderer is a composite renderer (the parent of a <template> tag), and allows different renderers to be applied to different data streams (see 'stream'). Any name can be used for a stream, as long as it is unique to the renderer. The order and number of streams must match the order and number of data sources defined in the XML configuration of the display component. For example, if the renderer is used in a Grid column, then the order and number of streams must match the order and number of fields in the XML definition of the column.
-
Type:xs:string, predefinedUse:optionalThe 'type' attribute has two distinct roles. First role: If the <renderer> is the parent of a <control> or <template> tag, then 'type' uniquely identifies the renderer from all other renderers that you define. The type can then be referred to in the XML configuration of a display component, such as in the configuration of a column in a Grid, or by the 'type' attribute of a renderer that is part of a composite renderer (see Second role). Second role: If the renderer is part of a composite renderer (a child of the <template> tag), then 'type' identifies the renderer that renders a particular data stream (see 'stream').