Background

The visualization of the opertor graph in Odysseus Studio can be customized in order to change its style and appearance. The following pictures show some examples of different visualization styles provided by Odysseus.

symbol_dark.xml Theme

symbol_light.xml Theme

symbol.xml Theme

The visualization framework provides several ways to control the appearance of the visualization which are described in the following sections.

Viewer configuration files

The way the nodes are drawn is defined in a special configuration file, the viewer configuration. It is an XML file that describes how to compose a node from different symbol elements. The schema of the file is defined in the SymbolSchema.xsd file. The following code snippet shows an example configuration file:

Viewer configuration file: example 
<Symbols xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="symbolSchema.xsd">
    
	<Symbol nodeName="ReceiverPO">
        <Size width="150" height="27"/>
        <SymbolElement type="ownerRectangle"/>
        <SymbolElement type="ownerText"/>
    </Symbol>

    <Default>
        <Size width="80" height="100"/>
        <SymbolElement type="ownerRectangle"/>
        <SymbolElement type="operator">
            <Parameter key="iconSetName" value="white"/>
            <Parameter key="marginLeft" value="10"/>
            <Parameter key="marginRight" value="10"/>
            <Parameter key="marginTop" value="10"/>
            <Parameter key="marginBottom" value="26"/>
        </SymbolElement>
        <SymbolElement type="ownerText">
            <Parameter key="offsetY" value="80"/>
        </SymbolElement>
    </Default>
    
</Symbols>

The Symbols element contains a list of definitions for node layouts. You can specifiy the layout individually for each type of physical operator by setting the nodeName attribute of the Symbol element to the respective class name. For each Symbol, you must specify its size and one ore more SymbolElement elements which describe the visual components to compose the node visualization. Some of these SymbolElement elements can additionally be configured using parameters that are specified as simple key value pairs. The following table gives you an overview of the available types of SymbolElement and the parameters they support.

TypeDescriptionSupported parameters
fillCircleCircle shape with filling
  • r
  • g
  • b
circleCircle shape without filling
  • r
  • g
  • b
fillRectangleRectangle shape with filling
  • r
  • g
  • b
rectangleRectangle shaoe without filling
  • r
  • g
  • b
selector

imageImage
  • resource
  • marginLeft
  • marginRight
  • marginTop
  • marginBottom
operatorShows a specific image for the physical operator from the given icon set
  • resource
  • iconSetName
  • marginLeft
  • marginRight
  • marginTop
  • marginBottom
invisibleInvisible (for layouting only)
selectivity

textShows the name of the operator
  • offsetX
  • offsetY
ownerTextShows the name of the operator
  • r
  • g
  • b
  • offsetX
  • offsetY
ownerRectangledraws a filled rectangle. The filling color is automatically determined to indicate the script/query the oeprator was created from

The following table gives an overview of the parameters:

Parameter namePossible valuesDescription
r, g, bInteger (0...255)RGB Color parameters. Important: Each color component must be individually specified as a single Parameter element!
marginLeftInteger (0...100)left margin (relative in percent!)
marginRightInteger (0...100)right margin (relative in percent!)
marginTopInteger (0...100)top margin (relative in percent!)
marginBottomInteger (0...100)bottom margin (relative in percent!)
offsetXInteger (0...100)Relative offset of X position (starting from left) in percent
offsetYInteger (0...100)Relative offset of Y position (starting from top) in percent
resourceStringImageID of the image to show. The image ID must be registered in the ImageManager.
iconSetNameStringName of the image set that should be used to automatically retrieve a matching image for the underlying physical operator. By default Odysseus provides the following image sets: white, black, and default. It is also possible to use external image sets stored in the Odysseus home directoy.


Besides the definitions for individual physical operators, the viewer configuration must specify the Default element which is applied to all operators that are not individually styled by a Symbol element. The structure of the Default element is similiar to the structure of the Symbol element.

How to use your own viewer configuration

In order to use your own viewer configuration, you need to perform the following steps:

  1. Create an viewer configuration file as describhed above and store it in the Odysseus home directory.
  2. Open the odysseusRCP.conf file and set the path of your viewer configuration file for the viewer.config key. Note: The path must be relative to the Odysseus home directory.
  3. Changes will apply after a restart of Odysseus Studio.


  • No labels