VectorPlotLegendCustomLabels Option

The VectorPlotLegendCustomLabels option sets the values and text to display for custom labels for the legend for the VectorPlot module. The OptionValue is the label value, a colon, and the text to be displayed. Separate multiple labels with a comma. An example of multiple labels might look like:

1.7:low, 2.1:medium, 2.9:intermediate, 3.2:elevated, 3.7:high

Syntax

object.Construct(“CreateModule”)

object.Option(“SourceModule”, “data file name”)

object.Option(“Type”, “VectorPlot”)

object.Do() or object.DoOnce()

object.Construct(“ModifyModule”)

object.Option(“Module”, “VectorPlot”)

object.Option(“VectorPlotLegendCustomLabels”, “OptionValue”)

object.Do() or object.DoOnce()

Example

This example sets the custom labels for the legend.

CommandApi.Construct ("ModifyModule")

CommandApi.Option ("Module", "VectorPlot")

CommandApi.Option ("VectorPlotLegendCustomLabels", "1.7:low, 2.1:medium, 2.9:intermediate, 3.2:elevated, 3.7:high")

CommandApi.Do()

Used by: VectorPlot module