ScatterPlot Module

 

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

 

Module Type

ScatterPlot

 

Syntax

object.Construct(“CreateModule”)

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

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

object.Do() or object.DoOnce()

 

object.Construct(“ModifyModule”)

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

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

object.Do() or object.DoOnce()

 

Option Name

ScatterPlotColorComponent

ScatterPlotColorFixed

ScatterPlotColormap

ScatterPlotColorMethod

ScatterPlotDensity

ScatterPlotFont

ScatterPlotLabelColor

ScatterPlotLabelColorMethod

ScatterPlotLabelField

ScatterPlotLabelFormatNumDigits

ScatterPlotLabelFormatPostfix

ScatterPlotLabelFormatPrefix

ScatterPlotLabelFormatType

ScatterPlotLabelJustification

ScatterPlotLabelSize

ScatterPlotLeaderLineWidth

ScatterPlotLegendAntialias

ScatterPlotLegendBGColor

ScatterPlotLegendCustomLabels

ScatterPlotLegendEnable

ScatterPlotLegendFGColor

ScatterPlotLegendFont

ScatterPlotLegendLabelHeight

ScatterPlotLegendLabelFormatNumDigits

ScatterPlotLegendLabelFormatPostfix

ScatterPlotLegendLabelFormatPrefix

ScatterPlotLegendLabelFormatType

ScatterPlotLegendLength

ScatterPlotLegendNumLabels

ScatterPlotLegendOrientation

ScatterPlotLegendShowBackground

ScatterPlotLegendTitle

ScatterPlotLegendTitleHeight

ScatterPlotLegendUseCustomLabels

ScatterPlotLegendWidth

ScatterPlotLegendXPos

ScatterPlotLegendYPos

ScatterPlotLineWidth

ScatterPlotMarker

ScatterPlotShowLabels

ScatterPlotShowLeaderLines

ScatterPlotShowLines

ScatterPlotSizeMarker

ScatterPlotSizePoint

ScatterPlotXOffset

ScatterPlotYOffset

 

 

Example

This example shows how to load a data file, create a scatter plot from it, and change one property.

 

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 data file

  CommandApi.Construct("Import")

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

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

  CommandApi.Option ("Path", "c:\program files\golden software\Voxler 4\Samples\GoldConcentration.dat")

  CommandApi.Option ("Filter", "dat")

  CommandApi.Do()

 

 'Add a scatter plot

  CommandApi.Construct("CreateModule")

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

  CommandApi.Option ("SourceModule", "GoldConcentration.dat ")

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

  CommandApi.Do()

 

 'Connect the isosurface and data modules

  CommandApi.Construct ("ConnectModules")

  CommandApi.Option ("SourceModule", "GoldConcentration.dat ")

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

  CommandApi.Do()

 

 'This section changes the symbol

  CommandApi.Construct ("ModifyModule")

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

   CommandApi.Option ("ScatterPlotMarker", "17")

  CommandApi.Do()

End Sub

 

Used by: CommandApi object, CreateModule, ModifyModule

 

 

See Also

Automation Model

Automation Example - ScatterPlot