result vector legend
Edits the vector plot legend properties.
Syntax
result vector legend default
result vector legend export <legend file>
result vector legend footer font=<font>, fontsize=<fontsize>, text=<text>, visibility=<true/false>
result vector legend header font=<font>, fontsize=<fontsize>, text=<text>, visibility=<true/false>
result vector legend import <legend file>
result vector legend layout <name1>=<value1>, <name2>=<value2> ... <nameN>=<valueN>
result vector legend title font=<font>, fontsize=<fontsize>, visibility=<true/false>
result vector legend values <name1>=<value1>, <name2>=<value2> ... <nameN>=<valueN>
Arguments
- default
- Resets the legend properties to the default values.
- export
- Export the legend settings file.
- <legend filename>
- From the file browser, select a location and filename to save the footer settings to.
- footer
- Define the legend footer properties.
- font=<font>
- The font type. Double-click to display the Font dialog to select your font.
- fontsize=<fontsize>
- The font size.
- text=<text>
- The footer text.
- visibility=<true/false>
- Display/hide the footer.
- header
- Define the legend header properties.
- font=<font>
- The font type. Double-click to display the Font dialog to select your font.
- fontsize=<fontsize>
- The font size.
- text=<text>
- The header text.
- visibility=<true/false>
- Display/hide the header.
- import
- Import a legend settings file.
- layout
- Define the legend layout settings.
- format=<scientific/engineering/fixed/auto>
- scientific - Displays the values in scientific format.
- interpolate="<levelid> <levelid>"
- Interpolates the colors in between the two colors that you select.
- interpolation=<linear/log>
- linear - Divides color bands into equal ranges in a linear manner.
- levels=<2-32>
- Select a number between 2 and 32. Displays more or less contour bands along with their respective ranges.
- position=<upperleft/lowerleft/upperright/lowerright>
- The position of the legend in the modeling window.
- precision=<1-12>
- Select a value for the numeric precision.
- reverse=<true>
- <true> - Reverses the legend values assigned to the contour bands.
- type =<fixed/dynamic>
- fixed - Fixed scale legend.
- title
- Define the legend title settings.
- font=<font>
- The font type. Double-click to display the Font dialog to select your font.
- fontsize=<fontsize>
- The font size.
- visibility=<true/false>
- Display/hide the title.
- values
- Define the legend's values.
- byModel=<true/false>
- Displays/hides the maximum and minimum legend values for each overlaid model separately.
- entitylabel=<true/false>
- Displays/hides the entity label for the maximum, minimum, local maximum, and local minimum legend values (if these options have been selected).
- fillcolor="<R> <G> <B>"
- Enter RGB values to display the legend with a color background (if the transparency=false).
- levelcolor="<levelid> <R> <G> <B>"
- Change the color of a band in the legend. Enter the level's ID followed by the RGB value.
- levelvalue="<levelid> <newvalue>"
- Change the value of a level.
- localmaximum=<true/false>
- Displays/hides the local maximum of a particular time step or simulation.
- localminimum=<true/false>
- Displays/hides the local minimum of a particular time step or simulation.
- maximum=<true/false>
- Displays/hides the maximum legend value.
- minimum=<true/false>
- Displays/hides the minimum legend value.
- transparency=<true/false>
- true - Displays the legend with a transparent background.
- valuefont=<font>
- The font name.
- valuefontsize=<fontsize>
- The font size.
Examples
result vector legend default
result vector legend export C:\legends\legend_settings.tcl
result vector legend footer font="Arial 12 normal roman" fontsize=12 text=Footer1 visibility=true
result vector legend header font="Verdana 10 normal roman" fontsize=12 text=Header1 visibility=true
result vector legend values levelcolor="8 Cyan"