VectorPlotLegendShowBackground Option

The VectorPlotLegendShowBackground option turns on or off the display of the background color in the legend for the VectorPlot module. The OptionValue is True or False. True turns on the display of the legend background. False turns off the display of the legend background.

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

object.Do() or object.DoOnce()

Example

This example turns on the display of the background for the legend.

CommandApi.Construct ("ModifyModule")

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

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

CommandApi.Do()

Used by: VectorPlot module