CurveOptions object

The CurveOptions object is used to define the curve properties when drawing curves.

CurveOptions objects can be created using the methods described below.

This page discusses:

Access

import visualization
session.charts[name].axes1[i].axisData.curves[i].curveOptions
session.charts[name].axes2[i].axisData.curves[i].curveOptions
session.charts[name].curves[name].curveOptions
session.curves[name].curveOptions
session.defaultChartOptions.defaultAxis1Options.axisData.curves[i]\
.curveOptions
session.defaultChartOptions.defaultAxis2Options.axisData.curves[i]\
.curveOptions
session.xyPlots[name].charts[name].axes1[i].axisData.curves[i]\
.curveOptions
session.xyPlots[name].charts[name].axes2[i].axisData.curves[i]\
.curveOptions
session.xyPlots[name].charts[name].curves[name].curveOptions
session.xyPlots[name].curves[name].curveOptions

CurveOptions(...)

This method creates a CurveOptions object.

Path

session.CurveOptions

xyPlot.CurveOptions.

Required arguments

None.

Optional arguments

symbolColor

A String specifying the color to be used when drawing a marker with this CurveOptions object. The default value is "White."

showSymbol

A Boolean specifying whether to draw the marker when using this CurveOptions object. The default value is ON.

symbolMarker

A SymbolicConstant specifying the marker type be used when drawing symbols using this CurveOptions object. Possible values are:

  • FILLED_CIRCLE

  • FILLED_SQUARE

  • FILLED_DIAMOND

  • FILLED_TRI

  • HOLLOW_CIRCLE

  • HOLLOW_SQUARE

  • HOLLOW_DIAMOND

  • HOLLOW_TRI

  • CROSS

  • XMARKER

  • POINT

The default value is FILLED_CIRCLE.

symbolSize

A Float specifying the marker size to be used when drawing markers using this CurveOptions object. The default value is 2.0.

lineColor

A String specifying the color to be used when drawing a line with this CurveOptions object. The default value is "White."

showLine

A Boolean specifying whether to draw the line when using this CurveOptions object. The default value is ON.

lineStyle

A SymbolicConstant specifying the line style to be used when drawing lines using this CurveOptions object. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

lineThickness

A Float specifying the line thickness in millimeters to be used when drawing lines using this CurveOptions object. The default value is 0.2.

Return value

A CurveOptions object.

Exceptions

ColorError.

setValues(...)

This method modifies the SymbolStyle object.

Required arguments

None.

Optional arguments

symbolColor

A String specifying the color to be used when drawing a marker with this CurveOptions object. The default value is "White."

showSymbol

A Boolean specifying whether to draw the marker when using this CurveOptions object. The default value is ON.

symbolMarker

A SymbolicConstant specifying the marker type be used when drawing symbols using this CurveOptions object. Possible values are:

  • FILLED_CIRCLE

  • FILLED_SQUARE

  • FILLED_DIAMOND

  • FILLED_TRI

  • HOLLOW_CIRCLE

  • HOLLOW_SQUARE

  • HOLLOW_DIAMOND

  • HOLLOW_TRI

  • CROSS

  • XMARKER

  • POINT

The default value is FILLED_CIRCLE.

symbolSize

A Float specifying the marker size to be used when drawing markers using this CurveOptions object. The default value is 2.0.

lineColor

A String specifying the color to be used when drawing a line with this CurveOptions object. The default value is "White."

showLine

A Boolean specifying whether to draw the line when using this CurveOptions object. The default value is ON.

lineStyle

A SymbolicConstant specifying the line style to be used when drawing lines using this CurveOptions object. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

lineThickness

A Float specifying the line thickness in millimeters to be used when drawing lines using this CurveOptions object. The default value is 0.2.

Return value

None.

Exceptions

None.

Members

The CurveOptions object has members with the same names and descriptions as the arguments to the setValues method.