Option Method

 

The Option method gives Voxler specifics about the command listed in the Construct method. Options vary based on the type of object being modified.

 

The Option method must be used in combination with the Construct method and the Do or DoOnce method to create an object.

 

Syntax

object.Option(“option_name”,”option_value”)

 

Example

This example demonstrates how to edit a ScatterPlot module’s color map properties. The Option methods list which module to edit (ScatterPlot) and which property of the ScatterPlot module (ScatterPlotColormap) to change.

 

'Change color of scatter plot symbols

  CommandApi.Construct ("ModifyModule")

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

  CommandApi.Option ("ScatterPlotColormap","Terrain")

  CommandApi.DoOnce()

 

Used by: CommandApi object

 

 

See Also

Automation Model