Chart Label Properties

Property Name	Description
General
Display Name	Specifies the display name of the object. Data type: String
Instance Name	Shows the instance name of the object. This property is read only.
Geometry
Height	Specifies the height of the object, in inches. Type a numeric value to change the height. Data type: Float
Width	Specifies the width of the object, in inches. Type a numeric value to change the width. Data type: Float
X	Specifies the horizontal coordinate of the upper-left corner of the object, relative to its parent container. Type a numeric value to change the position in inches. Data type: Float
Y	Specifies the vertical coordinate of the upper-left corner of the object, relative to its parent container. Type a numeric value to change the position in inches. Data type: Float
Label
Bottom Margin	Specifies the distance between the label text and the bottom border of the label, in inches. The four properties, Bottom Margin, Left Margin, Right Margin and Top Margin work together with the property Text Alignment. Type a numeric value to change the margin. Data type: Float
Color	Specifies the color of the label text. Applied when Fill Type of the label text is set to Color. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Fill Transparency	Specifies the color transparency of the label text, in percent. Type a numeric value to change the transparency. Data type: Integer
Fill Type	Specifies the fill pattern for the label text. Choose an option from the drop-down list. None - No fill (default). Color - Fills with a specified color. Data type: Integer
Font Face	Specifies the font face of the label text. Choose an option from the drop-down list. Data type: Enumeration
Font Rotation	Specifies the rotation angle of the label text around its center, in degrees. The default value is 0. Type a numeric value to change the rotation. Data type: Float
Font Size	Specifies the font size of the label text. Type an integer value to change the size. Data type: Integer
Font Style	Specifies the font style for the label text. Choose an option from the drop-down list. Data type: Enumeration
Left Margin	Specifies the distance between the label text and the left border of the label, in inches. The four properties, Bottom Margin, Left Margin, Right Margin and Top Margin work together with the property Text Alignment. Type a numeric value to change the margin. Data type: Float
Right Margin	Specifies the distance between the label text and the right border of the label, in inches. The four properties, Bottom Margin, Left Margin, Right Margin and Top Margin work together with the property Text Alignment. Type a numeric value to change the margin. Data type: Float
Text	Specifies the text of the label. Type a string to change the text. Data type: String
Text Alignment	Specifies the alignment style of the label text. It works together with the four properties, Bottom Margin, Left Margin, Right Margin and Top Margin. Choose an option from the drop-down list. Data type: Enumeration
Texture Background Color	Specifies the background color of the texture. This property does not work on chart labels at present. Data type: String
Top Margin	Specifies the distance between the label text and the top border of the label, in inches. The four properties, Bottom Margin, Left Margin, Right Margin and Top Margin work together with the property Text Alignment. Type a numeric value to change the margin. Data type: Float
Background
Border Color	Specifies the color of the label border. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Border End Caps	Specifies the ending style of the label border line. Choose an option from the drop-down list. Data type: Enumeration
Border Style	Specifies the line style of the label border. Choose an option from the drop-down list. Data type: Enumeration
Border Thickness	Specifies the width of the label border, in inches. Type a numeric value to change the thickness. Data type: Float
Border Transparency	Specifies the color transparency of the label border, in percent. Type a numeric value to change the transparency. Data type: Integer
Border Type	Specifies the border type of the label. Choose an option from the drop-down list. Data type: Enumeration
Border Variable Dash	Specifies whether to resize the dash automatically. true - If selected, the dash size will be adjusted automatically. false - If selected, the dash size will be of fixed size. Data type: Boolean
Color	Specifies the color of the label background. Applied when Fill Type of the label backgound is set to Color. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Fill Transparency	Specifies the transparency of the label background color, in percent. Type a numeric value to change the transparency. Data type: Integer
Fill Type	Specifies the fill pattern for the label background. Choose an option from the drop-down list. None - No fill (default). Color - Fills with a specified color. More Effects - Specifies either a gradient or an image as the fill effect in the Fill Effects dialog box. Data type: Enumeration
Inset Bottom	Specifies the bottom position of the background area, measured in a percentage of the label height, from the bottom edge of the label. Data type: Float
Inset Left	Specifies the left position of the background area, measured in a percentage of the label width, from the left edge of the label. Data type: Float
Inset Right	Specifies the right position of the background area, measured in a percentage of the label width, from the right edge of the label. Data type: Float
Inset Top	Specifies the top position of the background area, measured in a percentage of the label height, from the top edge of the label. Data type: Float
Icon
Border Color	Specifies the color of the icon border. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Border End Caps	Specifies the ending style of the icon border line. Choose an option from the drop-down list. Data type: Enumeration
Border Joint	Specifies the joint style of the icon border line. Choose an option from the drop-down list. Data type: Enumeration
Border Outlined	Specifies whether to show the icon border line in Outline Path. If the property is set to true, the icon border line will be shown in Outline Path; otherwise, in Fill Path. Data type: Boolean
Border Style	Specifies the line style of the icon border. Choose an option from the drop-down list. Data type: Enumeration
Border Thickness	Specifies the width of the border in inches. Type a numeric value to change the thickness. Data type: Float
Border Transparency	Specifies the color transparency of the icon border, in percent. Type a numeric value to change the transparency. Data type: Integer
Border Variable Dash	Specifies whether to resize the dash automatically. If the property is set to true, the dash size will be adjusted automatically; otherwise, the dash size will be of fixed size. Data type: Boolean
Color	Specifies the color of the icon background. Applied when Fill Type of the icon is set to Color. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Fill Transparency	Specifies the transparency of the icon background color, in percent. Type a numeric value to change the transparency. Data type: Integer
Fill Type	Specifies the fill pattern for the icon. Choose an option from the drop-down list. None - No fill (default). Color - Fills with a specified color. More Effects - Specifies either a gradient or an image as the fill effect in the Fill Effects dialog box. Data type: Enumeration
Height	Specifies the height of the icon, in inches. Type a numeric value to change the width. Data type: Float
Icon Alignment	Specifies the relative position of the icon to the label. Choose an option from the drop-down list. Data type: Enumeration
Icon Style	Specifies the style of the icon attached to the label. Choose an option from the drop-down list. Data type: Enumeration
Icon Text Gap	Specifies the distance between the icon and the label. Data type: Float

Property Name

Description

General

Display Name

Specifies the display name of the object.

Data type: String

Instance Name

Shows the instance name of the object. This property is read only.

Geometry

Height

Specifies the height of the object, in inches. Type a numeric value to change the height.

Data type: Float

Width

Specifies the width of the object, in inches. Type a numeric value to change the width.

Data type: Float

X

Specifies the horizontal coordinate of the upper-left corner of the object, relative to its parent container. Type a numeric value to change the position in inches.

Data type: Float

Y

Specifies the vertical coordinate of the upper-left corner of the object, relative to its parent container. Type a numeric value to change the position in inches.

Data type: Float

Label

Bottom Margin

Specifies the distance between the label text and the bottom border of the label, in inches. The four properties, Bottom Margin, Left Margin, Right Margin and Top Margin work together with the property Text Alignment. Type a numeric value to change the margin.

Data type: Float

Color

Specifies the color of the label text. Applied when Fill Type of the label text is set to Color. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Fill Transparency

Specifies the color transparency of the label text, in percent. Type a numeric value to change the transparency.

Data type: Integer

Fill Type

Specifies the fill pattern for the label text. Choose an option from the drop-down list.

None - No fill (default).
Color - Fills with a specified color.

Data type: Integer

Font Face

Specifies the font face of the label text. Choose an option from the drop-down list.

Data type: Enumeration

Font Rotation

Specifies the rotation angle of the label text around its center, in degrees. The default value is 0. Type a numeric value to change the rotation.

Data type: Float

Font Size

Specifies the font size of the label text. Type an integer value to change the size.

Data type: Integer

Font Style

Specifies the font style for the label text. Choose an option from the drop-down list.

Data type: Enumeration

Left Margin

Specifies the distance between the label text and the left border of the label, in inches. The four properties, Bottom Margin, Left Margin, Right Margin and Top Margin work together with the property Text Alignment. Type a numeric value to change the margin.

Data type: Float

Right Margin

Specifies the distance between the label text and the right border of the label, in inches. The four properties, Bottom Margin, Left Margin, Right Margin and Top Margin work together with the property Text Alignment. Type a numeric value to change the margin.

Data type: Float

Text

Specifies the text of the label. Type a string to change the text.

Data type: String

Text Alignment

Specifies the alignment style of the label text. It works together with the four properties, Bottom Margin, Left Margin, Right Margin and Top Margin. Choose an option from the drop-down list.

Data type: Enumeration

Texture Background Color

Specifies the background color of the texture. This property does not work on chart labels at present.

Data type: String

Top Margin

Specifies the distance between the label text and the top border of the label, in inches. The four properties, Bottom Margin, Left Margin, Right Margin and Top Margin work together with the property Text Alignment. Type a numeric value to change the margin.

Data type: Float

Background

Border Color

Specifies the color of the label border. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border End Caps

Specifies the ending style of the label border line. Choose an option from the drop-down list.

Data type: Enumeration

Border Style

Specifies the line style of the label border. Choose an option from the drop-down list.

Data type: Enumeration

Border Thickness

Specifies the width of the label border, in inches. Type a numeric value to change the thickness.

Data type: Float

Border Transparency

Specifies the color transparency of the label border, in percent. Type a numeric value to change the transparency.

Data type: Integer

Border Type

Specifies the border type of the label. Choose an option from the drop-down list.

Data type: Enumeration

Border Variable Dash

Specifies whether to resize the dash automatically.

true - If selected, the dash size will be adjusted automatically.
false - If selected, the dash size will be of fixed size.

Data type: Boolean

Color

Specifies the color of the label background. Applied when Fill Type of the label backgound is set to Color. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Fill Transparency

Specifies the transparency of the label background color, in percent. Type a numeric value to change the transparency.

Data type: Integer

Fill Type

Specifies the fill pattern for the label background. Choose an option from the drop-down list.

None - No fill (default).
Color - Fills with a specified color.
More Effects - Specifies either a gradient or an image as the fill effect in the Fill Effects dialog box.

Data type: Enumeration

Inset Bottom

Specifies the bottom position of the background area, measured in a percentage of the label height, from the bottom edge of the label.

Data type: Float

Inset Left

Specifies the left position of the background area, measured in a percentage of the label width, from the left edge of the label.

Data type: Float

Inset Right

Specifies the right position of the background area, measured in a percentage of the label width, from the right edge of the label.

Data type: Float

Inset Top

Specifies the top position of the background area, measured in a percentage of the label height, from the top edge of the label.

Data type: Float

Icon

Border Color

Specifies the color of the icon border. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border End Caps

Specifies the ending style of the icon border line. Choose an option from the drop-down list.

Data type: Enumeration

Border Joint

Specifies the joint style of the icon border line. Choose an option from the drop-down list.

Data type: Enumeration

Border Outlined

Specifies whether to show the icon border line in Outline Path. If the property is set to true, the icon border line will be shown in Outline Path; otherwise, in Fill Path.

Data type: Boolean

Border Style

Specifies the line style of the icon border. Choose an option from the drop-down list.

Data type: Enumeration

Border Thickness

Specifies the width of the border in inches. Type a numeric value to change the thickness.

Data type: Float

Border Transparency

Specifies the color transparency of the icon border, in percent. Type a numeric value to change the transparency.

Data type: Integer

Border Variable Dash

Specifies whether to resize the dash automatically. If the property is set to true, the dash size will be adjusted automatically; otherwise, the dash size will be of fixed size.

Data type: Boolean

Color

Specifies the color of the icon background. Applied when Fill Type of the icon is set to Color. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Fill Transparency

Specifies the transparency of the icon background color, in percent. Type a numeric value to change the transparency.

Data type: Integer

Fill Type

Specifies the fill pattern for the icon. Choose an option from the drop-down list.

None - No fill (default).
Color - Fills with a specified color.
More Effects - Specifies either a gradient or an image as the fill effect in the Fill Effects dialog box.

Data type: Enumeration

Height

Specifies the height of the icon, in inches. Type a numeric value to change the width.

Data type: Float

Icon Alignment

Specifies the relative position of the icon to the label. Choose an option from the drop-down list.

Data type: Enumeration

Icon Style

Specifies the style of the icon attached to the label. Choose an option from the drop-down list.

Data type: Enumeration

Icon Text Gap

Specifies the distance between the icon and the label.

Data type: Float