SMS:Vector Legend Options: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 2: Line 2:
The ''Vector Legend Options'' controls the formatting and location of a displayed legend. If a vector [[SMS:Datasets|dataset]] exists and is displayed, the legend will be shown if the ''Legend'' check box on the [[SMS:Vector Display Options|''Vector Display Options'']] dialog is checked. This window is accessed only from the '''Legend Options''' button on the [[SMS:Vector Display Options|''Vector Display Options'']] page of the [[ SMS:Display Options|''Display Options'']] dialog.
The ''Vector Legend Options'' controls the formatting and location of a displayed legend. If a vector [[SMS:Datasets|dataset]] exists and is displayed, the legend will be shown if the ''Legend'' check box on the [[SMS:Vector Display Options|''Vector Display Options'']] dialog is checked. This window is accessed only from the '''Legend Options''' button on the [[SMS:Vector Display Options|''Vector Display Options'']] page of the [[ SMS:Display Options|''Display Options'']] dialog.


The Formatting section includes fields for the Title and Units displayed with the legend, a Font selection button for text style, and Height and Width fields for legend size.
The ''Formatting'' section includes fields for the ''Title'' and ''Units'' displayed with the legend, a Font selection button for text style, and ''Height'' and ''Width'' fields for legend size.


Since vector datasets can be displayed for multiple modules at the same time and, therefore, multiple vector legends can be displayed, the Title field can include keywords for convenient labeling. The following title keywords are case sensitive:
Since vector datasets can be displayed for multiple modules at the same time and, therefore, multiple vector legends can be displayed, the ''Title'' field can include keywords for convenient labeling. The following title keywords are case sensitive:
:* "MODULE" – will be replaced with the title of the vector data set's module
:* "MODULE" – will be replaced with the title of the vector data set's module
:* "DS" – will be replaced with the name of the currently selected vector data set
:* "DS" – will be replaced with the name of the currently selected vector dataset
:* "DS:TS" – will be replaced with the name of the currently selected vector data set followed by the current time step
:* "DS:TS" – will be replaced with the name of the currently selected vector dataset followed by the current time step
A title of "MODULE DS:TS" is best since it will automatically update as vector data set selection changes.
A title of "MODULE DS:TS" is best since it will automatically update as vector dataset selection changes.


The Units field includes the single case sensitive keyword of "DEFAULT", which will be replaced with the velocity units of meters per second (m/s) or feet per sceond (ft/s) based on the current coordinate system's horizontal units.
The ''Units'' field includes the single case sensitive keyword of "DEFAULT", which will be replaced with the velocity units of meters per second (m/s) or feet per sceond (ft/s) based on the current coordinate system's horizontal units.


The Location section includes a combo box for specifying the location of the displayed legend. The locations include:
The ''Location'' section includes a combo box for specifying the location of the displayed legend. The locations include:
:* Top left corner
:* Top left corner
:* Bottom left corner
:* Bottom left corner

Revision as of 15:39, 10 June 2013

Vector Legend Options dialog

The Vector Legend Options controls the formatting and location of a displayed legend. If a vector dataset exists and is displayed, the legend will be shown if the Legend check box on the Vector Display Options dialog is checked. This window is accessed only from the Legend Options button on the Vector Display Options page of the Display Options dialog.

The Formatting section includes fields for the Title and Units displayed with the legend, a Font selection button for text style, and Height and Width fields for legend size.

Since vector datasets can be displayed for multiple modules at the same time and, therefore, multiple vector legends can be displayed, the Title field can include keywords for convenient labeling. The following title keywords are case sensitive:

  • "MODULE" – will be replaced with the title of the vector data set's module
  • "DS" – will be replaced with the name of the currently selected vector dataset
  • "DS:TS" – will be replaced with the name of the currently selected vector dataset followed by the current time step

A title of "MODULE DS:TS" is best since it will automatically update as vector dataset selection changes.

The Units field includes the single case sensitive keyword of "DEFAULT", which will be replaced with the velocity units of meters per second (m/s) or feet per sceond (ft/s) based on the current coordinate system's horizontal units.

The Location section includes a combo box for specifying the location of the displayed legend. The locations include:

  • Top left corner
  • Bottom left corner
  • Top right corner
  • Bottom right corner
  • Screen location – specify the location based on screen precentages
  • World location – specify the coordinate location

Related Topics