Scripting > Plotting Basics


Viewport Class

Viewport objects hold the data set curves. Viewport methods are described below.

 

Viewport Methods

Method

Returns

Description

addAxisMarker(AxisMarker marker)

None

Adds a marker line described by the AxisMarker parameter

addXAxisMarker()

None

Display the Axis Marker Properties Dialog for a marker line to add to the X axis

addXAxisMarker(floating-point value)

None

Add an X Axis marker at the location specified by value

addXAxisMarker(string value)

None

Add a X Axis marker at the location specified by value

addYAxisMarker()

None

Display the Axis Marker Properties Dialog for a marker line to add to the Y axis

addYAxisMarker(string value)

None

Add a Y Axis marker at the location specified by value

editProperties()

None

Display the Edit Properties dialog for this Viewport

getAxis(string axisName)

Axis

return the Axis specified by axisName for this Viewport

getAxisLabel(string axisName)

AxisLabel

Return the AxisLabel for the axis specified by axisName for this Viewport

getAxisTics(string axisName)

AxisTics

Return the AxisTics for the axis specified by axisName for this Viewport

getBackground()

Color

Return the background color for the Viewport as a Color.

getBackgroundString()

string

Return the background color name for the Viewport as a string.

getBorderColor()

Color

Return the border color for the Viewport as a Color.

getBorderColorString()

string

Return the background color name for the Viewport as a string

getBorderWeight()

float

Return the border weight for this Viewport

getFillPatternString()

string

Return the fill pattern for this Viewport as a String

getMajorGridXColor()

Color

Return the color of the vertical lines of the major grid for this Viewport as a Color

getMajorGridXColorString ()

string

Return the color of the vertical lines of the major grid for this Viewport as a string

getMajorGridXWidth ()

floating point

Return the width of the vertical lines of the major grid for this Viewport

getMajorGridYColor ()

Color

Return the color of the horizontal lines of the major grid of this Viewport as a Color

getMajorGridYColorString ()

string

Return the color of the horizontal lines of the major grid for this Viewport as a string

getMajorGridYWidth ()

floating point

Return the width of the vertical lines of the major grid for this Viewport

getMinorGridXColor()

Color

Return the color of the vertical lines of the minor grid for this Viewport as a color

getMinorGridXColorString()

string

Return the color of the vertical lines of the minor grid for this Viewport as a string

getMinorGridXWidth()

floating point

Return the width of the vertical lines of the minor grid for this Viewport

getMinorGridYColor()

Color

Return the color of the horizontal lines of the minor grid for this Viewport as a Color.

getMinorGridYColorString()

string

Return the color of the horizontal lines of the minor grid for this Viewport as a string

getMinorGridYWidth()

floating point

Return the width of the vertical lines of the minor grid for this Viewport

isBackgroundVisible()

0/1

Return whether the background is drawn for this Viewport

isBorderVisible()

0/1

Return whether the border is drawn for this Viewport

isMajorGridXVisible()

0/1

Return whether the vertical lines of the major grid are drawn for this Viewport

isMajorGridYVisible ()

0/1

Return whether the horizontal lines of the major grid are drawn for this Viewport

isMinorGridXVisible()

0/1

Return whether the vertical lines of the minor grid are drawn for this Viewport

isMinorGridYVisible ()

0/1

Return whether the horizontal lines of the minor grid are drawn for this Viewport

setBackground(string colorString)

None

Set the background to the color specified by colorString

setBorderColor(string borderColor)

None

Set the border color for this Viewport

setBorderWeight(floating-point borderWeight)

None

Set the border weight for this Viewport

setBackgroundVisible(0/1 state)

None

Set whether to draw the background for this Viewport

setBorderVisible(0/1 state)

None

Set whether to draw the border for this Viewport

setFillPattern(string pattern)

None

Set the fill pattern for this Viewport

setGridColor(string colorString)

None

Set the color of the horizontal and vertical lines of the major and minor grids for this Viewport.

setGridXColor(string colorString)

None

Set the color of the vertical lines of the major and minor grids for this Viewport.

setGridYColor(string colorString)

None

Set the color of the horizontal lines of the major and minor grids for this Viewport.

setMajorGridXColor(string majorGridXColor)

None

Set the color of the vertical lines of the major grid for this Viewport.

setMajorGridXVisible(0/1 state)

None

Set whether to draw the vertical lines of the major grid for this Viewport

setMajorGridXWidth(floating-point gridLineWidth)

None

Set the width of the vertical lines of the major grid for this Viewport

setMajorGridYColor(string majorGridYColor)

None

Set the color of the horizontal lines of the major grid for this Viewport.

setMajorGridYVisible(0/1 state)

None

Set whether to draw the horizontal lines of the major grid for this Viewport

setMajorGridYWidth(floating-point gridLineWidth)

None

Set the width of the horizontal lines of the major grid for this Viewport

setMinorGridXColor(string minorGridXColor)

None

Set the color of the vertical lines of the minor grid for this Viewport.

setMinorGridXVisible(0/1 state)

None

Set whether to draw the vertical lines of the minor grid for this Viewport

setMinorGridXWidth(floating-point gridLineWidth)

None

Set the width of the vertical lines of the minor grid for this Viewport

setMinorGridYColor(string minorGridYColor)

None

Set the color of the horizontal lines of the minor grid for this Viewport.

setMinorGridYVisible(0/1 state)

None

Set whether to draw the horizontal lines of the minor grid for this Viewport

setMinorYGridWidth(floating-point gridLineWidth)

None

Set the width of the horizontal lines of the minor grid for this Viewport