VectorPlotLegendUseCustomLabels Option

The VectorPlotLegendUseCustomLabels option turns on the display of custom labels for the legend for the VectorPlot module. The OptionValue is True or False. True displays the custom labels. False displays automatic labels.

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(“VectorPlotLegendUseCustomLabels”, “OptionValue”)

object.Do() or object.DoOnce()

Example

This example turns on the display of custom labels for the legend.

CommandApi.Construct ("ModifyModule")

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

CommandApi.Option ("VectorPlotLegendUseCustomLabels", "True")

CommandApi.Do()

Used by: VectorPlot module