TextStyle object

The TextStyle object is used to store the text properties to be used for drawing XY-plot text objects.

TextStyle objects are automatically created when creating a chart or can be created with methods described below.

This page discusses:

Access
TextStyle(...)
setValues(...)
Members

Access

import visualization
session.charts[name].axes1[i].labelStyle
session.charts[name].axes1[i].titleStyle
session.charts[name].axes2[i].labelStyle
session.charts[name].axes2[i].titleStyle
session.charts[name].legend.textStyle
session.charts[name].legend.titleStyle
session.charts[name].tagTextStyle
session.defaultChartOptions.defaultAxis1Options.labelStyle
session.defaultChartOptions.defaultAxis1Options.titleStyle
session.defaultChartOptions.defaultAxis2Options.labelStyle
session.defaultChartOptions.defaultAxis2Options.titleStyle
session.defaultChartOptions.legend.textStyle
session.defaultChartOptions.legend.titleStyle
session.defaultChartOptions.tagTextStyle
session.defaultPlot.title.titleStyle
session.xyPlots[name].charts[name].axes1[i].labelStyle
session.xyPlots[name].charts[name].axes1[i].titleStyle
session.xyPlots[name].charts[name].axes2[i].labelStyle
session.xyPlots[name].charts[name].axes2[i].titleStyle
session.xyPlots[name].charts[name].legend.textStyle
session.xyPlots[name].charts[name].legend.titleStyle
session.xyPlots[name].charts[name].tagTextStyle
session.xyPlots[name].title.titleStyle

TextStyle(...)

This method creates a TextStyle.

Path

session.TextStyle

xyPlot.TextStyle

Required arguments

None.

Optional arguments

color: A String specifying the color to be used when drawing text with this TextStyle object. The default value is "White".
show: A Boolean specifying whether to draw the text when using this TextStyle object. The default value is ON.
font: A String specifying the name of the font to be used when drawing text with this TextStyle object. The default value is "-*-verdana-medium-r-normal-*-*-120-*-*-p-*-*-*".
rotationAngle: A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

Return value

A TextStyle object.

Exceptions

ColorError

setValues(...)

This method modifies the TextStyle object.

Required arguments

None.

Optional arguments

color: A String specifying the color to be used when drawing text with this TextStyle object. The default value is "White".
show: A Boolean specifying whether to draw the text when using this TextStyle object. The default value is ON.
font: A String specifying the name of the font to be used when drawing text with this TextStyle object. The default value is "-*-verdana-medium-r-normal-*-*-120-*-*-p-*-*-*".
rotationAngle: A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

Return value

None.

Exceptions

None.

Members

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