legend
The legend module is used to place a 2D legend which helps correlate colors to analytical values or materials. The legend shows the relationship between the selected data component for a particular module and the colors shown in the viewer. For this reason, the legend’s Input Object port must be connected to the output of a module which is connected to the viewer and is generally the dominant colored object in view.
Many modules with renderable output ports have a selector to choose which data component is used for coloring. The name of the selected data component will be displayed as the title of the legend if the label options are set to automatic (the default).
If the data component to be viewed is either Geo_Layer or Material_ID (for models where the grid is based upon geology), the Geology Legend port from gridding and horizons (or lithologic modeling) must also be connected to provide the geologic layer or material names for automatic labeling. When this port is connected it will have no effect if any other data component is selected.
The minimum and maximum values are taken from the data input as defined in the datamap. Labels can be placed at user defined intervals along the color scale bar. Labels can consist of user input alphanumerical values or automatically determined numerical values.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Object | Renderable | A renderable object for creating the Legend color scale. |
| Input | Geology Legend | Geology Legend | Geology legend information. |
| Input | Contour levels | Contours | Information required to properly set contour levels within Legend. |
| Output | Output Object | Renderable | A renderable object displaying the legend. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | The Allow Run toggle, when deselected, will prevent the module from running. |
| Execute | Button | This button will force the module to run even if the Allow Run toggle has been turned off. This allows the user to make a number of changes before updating. |
| Orientation | Choice: Horizontal, Vertical | Orientation allows the user to determine which orientation is used when creating a 2D Legend. |
| Anchor Point | Placement | The Anchor Point determines where to place the legend, and which point on the legend to base placement on. |
| Position Offset | 2D Percentage | The position offset for the legend placement. |
| Overlay | Choice: Behind Scene, In front of scene | The Overlay control allows the user to put the legend behind the model or in front of it. |
| Flip Legend | Boolean | The Flip Legend toggle inverts the legend putting high values at the bottom. |
| Units | String | The Units to add to the end of each label. |
| Texture X Scale | Double | The size of the scale in screen space (X direction). |
| Texture Y Scale | Double | The size of the scale in screen space (Y direction). |
Scale Properties
| Property | Type | Description |
|---|---|---|
| Scale Size | Double | The size of the scale in screen space. |
| Display Scale In Output | Boolean | The Display Scale in Output toggle specifies whether or not to output the colored portion of the legend in the Legend’s Output Object port. |
| Force Gradiated Colors | Boolean | The Force Gradiated Colors toggle will cause the Legend to display gradiated colors instead of solid color breaks when contour data is passed in. |
| Equally Size Contours | Boolean | The Equally Size Contours toggle will cause the Legend to display each contour as equal in size, rather than relative to the portion of the data range represented. |
| Use Integers As Contours | Boolean | The Use Integers As Contours toggle will cause the legend to treat the input data as contoured, with each integer being the label of each contour. |
| Aspect Ratio | Double | The Aspect Ratio restricts the size of the scale to a percentage of the Scale Size. |
| Boundary Lines | Boolean | The Boundary Lines toggle specifies whether or not a boundary box is to be drawn around the Legend scale bar. |
| Value Markers | Boolean | The Value Markers toggle specifies whether or not a tick mark is to be drawn at each label location. |
| Boundary Thickness | Double | The Boundary Thickness value determines how thick to draw the boundary lines, as a percentage of the scale size. |
| Boundary Color | Color | The Boundary Color sets the color of the lines that surround the Legend. |
| Value Marker Thickness | Double | The Value Marker Thickness value determines how thick to draw the ticks, as a percentage of the scale size. |
| Gap Size | Double | The Gap Size determines how large a gap to leave between solid blocks, as a percentage of the scale size. The labels must be centered, and the legend in solid or textured blocks for gaps to be allowed. |
Text Properties
| Property | Type | Description |
|---|---|---|
| Labels On | Boolean | The Labels On toggle is used to specify whether or not the data labels are to be displayed with the Legend. |
| Font | Font | The Title Font allows the user to alter the basic look of the font. |
| Title | Expression | Title sets the template the title is generated with. |
| Labels | Expression | Labels sets the template the labels are generated with. |
| Title Offset | 2D Percentage | The offset for the title position. |
| Label Offset | 2D Percentage | The offset for the label position. |
| Title Side | Choice: Left, Right, Top, Bottom | The Title Side determines where the title for the Legend will display. |
| Label Side | Choice: Left, Right, Top, Bottom | The Label Side determines which side of the scale to place the labels on. |
| Title Size | Double | The Title Size determines how large to make the title text. It scales with the Scale Size. |
| Label Size | Double | The Label Size determines how large to make the labels’ text. It scales with the Scale Size. |
| Title Alignment | Alignment | Title Alignment allows the user to align the title appropriately. |
| Label Alignment | Alignment | Label Alignment allows the user to align the labels appropriately. |
| Title Color | Color | The Title Color sets the color of the title that labels the Legend. |
| Label Color | Color | The Label Color sets the color of the labels on the Legend. |
| Label Min | Boolean | The Label Min toggle places a label at the bottom (min) of the data. This only applies to linear or log unformatted. |
| Label Max | Boolean | The Label Max toggle places a label at the top (max) of the data. This only applies to linear or log unformatted. |
| Label Bold | Boolean | The Label Bold toggle determines whether to bold the font used in labels. |
| Label Italic | Boolean | The Label Italic toggle determines whether to italicize the font used in labels. |
| Centered Analytic Labels | Boolean | Whether or not to use centered labels when working with contoured analytes. |
| Centered Analytic Label | Expression | Labels sets the template the labels are generated with when working with contoured analytes. |
| Label Angle | Double | The Label Angle specifies how to rotate the labels. |
| Label Type | Choice: Set By Data, Set By User | The Label Type allows the user to choose between data generated labels or user specified labels. |
| Logarithmic Decades | Choice: Log, Unformatted | When the data has been log processed, the Logarithmic Decades determines the number of label increments in the color scale bar. If the Log option is selected the Labels Per Log Decade value is used. If Unformatted is selected the Number Of Intervals is used. |
| Labels Per Log Decade | Integer | If the Log Option is selected for Logarithmic Decades, the increments per decade can be set with this value. |
| Number Of Intervals | Integer | If the data has been processed in linear space or the Unformatted option is selected for Logarithmic Decades, the total increments for the color scale bar can be set with this value. |
| Format Label Numbers | Number Formatting | The Format Label Numbers control allows the user to set how numbers that are turned into labels will be formatted. |
| Type In Labels | Editable Strings | If the Type-In Labels option is selected for Label Processing, the labels may be set using this control. |
| Prepend Min | String | The Prepend Min string is placed before the label for the minimum value in the Legend. |
| Prepend Max | String | The Prepend Max string is placed before the label for the maximum value in the Legend. |