VectorPlot

 

The VectorPlot module is created with the CreateModule command by setting the Type to VectorPlot. The properties of the VectorPlot are altered with the ModifyModule command. This is similar to the Network | Graphics Output | VectorPlot command.

 

Module Type

VectorPlot

 

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

object.Do() or object.DoOnce()

 

Option Name

VectorPlotOrientation

VectorPlotFrequency

VectorPlotSlice

VectorPlotVectorStyle

VectorPlotColorMethod

VectorPlotScaleMethod

VectorPlotMinScale

VectorPlotMaxScale

VectorPlotHeadScale

VectorPlotDotSize

VectorPlotReverse

VectorPlotLineWidth

VectorPlotColor

VectorPlotColormap

VectorPlotColorComponent

VectorPlotLabelFormatType

VectorPlotLabelFormatNumDigits

VectorPlotLabelFormatPrefix

VectorPlotLabelFormatPostfix

VectorPlotLegendEnable

VectorPlotLegendOrientation

VectorPlotLegendXPos

VectorPlotLegendYPos

VectorPlotLegendWidth

VectorPlotLegendLength

VectorPlotLegendTitle

VectorPlotLegendTitleHeight

VectorPlotLegendNumLabels

VectorPlotLegendUseCustomLabels

VectorPlotLegendCustomLabels

VectorPlotLegendLabelHeight

VectorPlotLegendFont

VectorPlotLegendAntialias

VectorPlotLegendFGColor

VectorPlotLegendBGColor

VectorPlotLegendShowBackground

 

Example

This example shows how to create a test lattice and add a VectorPlot module to it.

 

Sub Main

 'Declares VoxlerApp as an object

  Dim VoxlerApp As Object

 

 'Creates an instance of the Voxler application object

 'and assigns it to the variable named "VoxlerApp"

  Set VoxlerApp = CreateObject("Voxler.Application")

 

 'Make Voxler visible

  VoxlerApp.Visible = True

 

 'Access CommandApi

  Set CommandApi = VoxlerApp.CommandApi

 

 'Create a new Voxler document

  CommandApi.Construct ("New")

  CommandApi.DoOnce()

 

 'Load the test lattice

  CommandApi.Construct("CreateModule")

  CommandApi.Option("AutoConnect", "False")

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

  CommandApi.Option ("Type", "TestLattice")

  CommandApi.Do()

 

 'Add a VectorPlot module

  CommandApi.Construct("CreateModule")

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

  CommandApi.Option ("SourceModule", "TestLattice")

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

  CommandApi.Do()

End Sub

 

Used by: CommandApi object, CreateModule, ModifyModule

 

 

See Also

Automation Model

Automation Example - VectorPlot