Previous Topic
KPI Chart Label Properties
This topic describes the properties of a Chart Label object in a KPI chart.
| Property Name | Description |
|---|---|
| Geometry | |
| Height | Specifies the height of the object. Type a numeric value to change the height.
Data type: Float |
| Width | Specifies the width of the object. Type a numeric value to change the width.
Data type: Float |
| X | Specifies the horizontal coordinate of the top left corner of the object, relative to its parent container. Type a numeric value to change the position.
Data type: Float |
| Y | Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. Type a numeric value to change the position.
Data type: Float |
| CSS | |
| Class | Specifies the name of the Class Selector to apply to the object, which you define in the CSS file of the style the report applies.
For example, if you define the CSS file as follows:
To apply the Class Selector in the file to the object, type C in the value cell. Data type: String |
| Style |
Specifies the style to apply to the object. You can specify the style in two ways:
Data type: String |
| Label | |
| Bottom Margin | Specifies the distance between the label text and the bottom border of the label. 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 customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Fill Transparency | Specifies the 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. Can be none, color, texture or gradient.
Data type: Integer |
| Font Effect | Specifies the special effect for the label text. Choose an option from the drop-down list.
Data type: Enumeration |
| 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 Script | Specifies whether the label text will be in superscript or subscript form, or neither of them. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Shearing | Specifies the shearing transformation of the label text around its center. The default value is 0. Type a numeric value to change the shearing.
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 Strikethrough | Specifies the style of the line by which the label text is struck through. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Style | Specifies the font style for the label text. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Underline | Specifies the style of the horizontal line under the label text. Choose an option from the drop-down list. When patterned line or bold patterned is selected, a line or bold line in the pattern of the text will be drawn.
Data type: Enumeration
|
| Gradient End Color | Specifies the color of the point where the gradient ends. Applied when Fill Type of the label text is set to gradient. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Gradient End X | Specifies the horizontal position where the gradient ends, measured in a percentage of the label text width. Applied when Fill Type of the label text is set to gradient.
Data type: Integer |
| Gradient End Y | Specifies the vertical position where the gradient ends, measured in a percentage of the label text height. Applied when Fill Type of the label text is set to gradient.
Data type: Integer |
| Gradient Start Color | Specifies the color of the point where the gradient begins. Applied when Fill Type of the label text is set to gradient. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Gradient Start X | Specifies the horizontal position where the gradient begins, measured in a percentage of the label text width. Applied when Fill Type of the label text is set to gradient.
Data type: Integer |
| Gradient Start Y | Specifies the vertical position where the gradient begins, measured in a percentage of the label text height. Applied when Fill Type of the label text is set to gradient.
Data type: Integer |
| Gradient Style | Specifies the gradient style for the label text. Applied when Fill Type of the label text is set to gradient. 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. 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 |
| Outline Color | Specifies the color for the label text outline. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Outline End Caps | Specifies the ending style for the label text outline. Choose an option from the drop-down list.
Data type: Integer |
| Outline Joint | Specifies the joint style for the label text outline. Choose an option from the drop-down list.
Data type: Enumeration |
| Outline Outlined | Specifies whether to show the label text outline in outline form. If the property is set to true, the outline will be shown in outline form; otherwise, in whole form.
Data type: Boolean |
| Outline Style | Specifies the style for the label text outline. Choose an option from the drop-down list.
Data type: Enumeration |
| Outline Thickness | Specifies the thickness for the label text outline.
Data type: Float |
| Outline Transparency | Specifies the transparency for the label text outline, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Outline 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 |
| Right Margin | Specifies the distance between the label text and the right border of the label. 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. Applied when Fill Type of the label text is set to texture. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Texture Foreground Color | Specifies the foreground color of the texture. Applied when Fill Type of the label text is set to texture. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Texture Style | Specifies the texture style for the label. Applied when Fill Type of the label text is set to texture. Choose an option from the drop-down list.
Data type: Enumeration |
| Top Margin | Specifies the distance between the label text and the top border of the label. 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 |
| Word Wrap | Specifies whether to enable the word wrap function for the label text, not applying to radar charts, bubble charts, scatter charts and gauge charts. If the text contains special characters (such as ",", ".", and space), it will be broken at the position of one of the special characters.
Data type: Boolean |
| Background | |
| Border Color | Specifies the color of the label border. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns 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 Joint | Specifies the joint style of the label border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Outlined | Specifies whether to show the label border line in Outline Path. If the property is set to true, the label border line will be shown in Outline Path; otherwise, in Fill Path.
Data type: Boolean |
| 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. Type a numeric value to change the thickness.
Data type: Float |
| Border Transparency | Specifies the 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.
Data type: Boolean |
| Color | Specifies the color of the label background. Applied when Fill Type of the label background is set to color. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Fill Transparency | Specifies the transparency of the label background, 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. Can be none, color, texture, gradient or image.
Data type: Enumeration |
| Gradient End Color | Specifies the color of the point where the gradient ends. Applied when Fill Type of the label background is set to gradient. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Gradient End X | Specifies the horizontal position where the gradient ends, measured in a percentage of the label width. Applied when Fill Type of the label background is set to gradient.
Data type: Integer |
| Gradient End Y | Specifies the vertical position where the gradient ends, measured in a percentage of the label height. Applied when Fill Type of the label background is set to gradient.
Data type: Integer |
| Gradient Start Color | Specifies the color of the point where the gradient begins. Applied when Fill Type of the label background is set to gradient. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Gradient Start X | Specifies the horizontal position where the gradient begins, measured in a percentage of the label width. Applied when Fill Type of the label background is set to gradient.
Data type: Integer |
| Gradient Start Y | Specifies the vertical position where the gradient begins, measured in a percentage of the label height. Applied when Fill Type of the label background is set to gradient.
Data type: Integer |
| Gradient Style | Specifies the gradient style for the label background. Applied when Fill Type of the label background is set to gradient. Choose an option from the drop-down list.
Data type: Enumeration |
| Image File | Specifies the file name of the image, a portion of which will be displayed as the label background. Applied when Fill Type of the label background is set to image. Type the file name with suffix in the value cell. If the image is outside of the current catalog, you should include the full path of the image correctly.
Data type: String |
| Image Height | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be displayed as the label background. They take effect when Fill Type of the label background is set to image.
Image Height specifies the height of the image portion, measured in a percentage of the image height. Data type: Integer |
| Image Layout | Specifies the layout style for the image that will be displayed as the label background. Applied when Fill Type of the label background is set to image. Choose an option from the drop-down list.
Data type: Integer |
| Image Width | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be displayed as the label background. They take effect when Fill Type of the label background is set to image.
Image Width specifies the width of the image portion, measured in a percentage of the image width. Data type: Integer |
| Image X | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be displayed as the label background. They take effect when Fill Type of the label background is set to image.
Image X specifies the distance between the left border of image and the portion that will contain the pattern, measured in a percentage of the image width. Data type: Integer |
| Image Y | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be displayed as the label background. They take effect when Fill Type of the label background is set to image.
Image Y specifies the distance between the top border of image and the portion that will contain the pattern, measured in a percentage of the image height. Data type: Integer |
| 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 |
| Texture Background Color | Specifies the background color of the texture. Applied when Fill Type of the label background is set to texture. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Texture Foreground Color | Specifies the foreground color of the texture. Applied when Fill Type of the label background is set to texture. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Texture Style | Specifies the texture style for the label background. Applied when Fill Type of the label background is set to texture. Choose an option from the drop-down list.
Data type: Enumeration |
| Icon | |
| Border Color | Specifies the color of the icon border. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns 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. Type a numeric value to change the thickness.
Data type: Float |
| Border Transparency | Specifies the 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 customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Fill Transparency | Specifies the transparency of the icon background, 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. Can be none, color, texture, gradient or image.
Data type: Enumeration |
| Gradient End Color | Specifies the color of the point where the gradient ends. Applied when Fill Type of the icon is set to gradient. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Gradient End X | Specifies the horizontal position where the gradient ends, measured in a percentage of the icon width. Applied when Fill Type of the icon is set to gradient.
Data type: Integer |
| Gradient End Y | Specifies the vertical position where the gradient ends, measured in a percentage of the icon height. Applied when Fill Type of the icon is set to gradient.
Data type: Integer |
| Gradient Start Color | Specifies the color of the point where the gradient begins. Applied when Fill Type of the icon is set to gradient. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Gradient Start X | Specifies the horizontal position where the gradient begins, measured in a percentage of the icon width. Applied when Fill Type of the icon is set to gradient.
Data type: Integer |
| Gradient Start Y | Specifies the vertical position where the gradient begins, measured in a percentage of the icon height. Applied when Fill Type of the icon is set to gradient.
Data type: Integer |
| Gradient Style | Specifies the gradient style for the icon. Applied when Fill Type of the icon is set to gradient. Choose an option from the drop-down list.
Data type: Enumeration |
| Height | Specifies the height of the icon. 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 |
| Image File | Specifies the file name of the image, a portion of which will be displayed as the icon background. Applied when Fill Type of the icon is set to image. Type the file name with suffix in the value cell. If the image is outside of the current catalog, you should include the full path of the image correctly.
Data type: String |
| Image Height | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be
displayed as the icon background. They take effect when Fill Type of the icon is set to image.
Image Height specifies the height of the image portion, measured in a percentage of the image height. Data type: Integer |
| Image Layout | Specifies the layout style for the image that will be
displayed as the icon background. Applied when Fill Type of the icon is set to image. Choose an option from the drop-down list.
Data type: Enumeration |
| Image Width | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be
displayed as the icon background. They take effect when Fill Type of the icon is set to image.
Image Width specifies the width of the image portion, measured in a percentage of the image width. Data type: Integer |
| Image X | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be
displayed as the icon background. They take effect when Fill Type of the icon is set to image.
Image X specifies the distance between the left border of image and the portion that will contain the pattern, measured in a percentage of the image width. Data type: Integer |
| Image Y | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be
displayed as the icon background. They take effect when Fill Type of the icon is set to image.
Image Y specifies the distance between the top border of image and the portion that will contain the pattern, measured in a percentage of the image height. Data type: Integer |
| Texture Background Color | Specifies the background color of the texture. Applied when Fill Type of the icon is set to texture. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Texture Foreground Color | Specifies the foreground color of the texture. Applied when Fill Type of the icon is set to texture. Choose a color from the drop-down list or select Custom to customize a color, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Texture Style | Specifies the texture style for the icon. Applied when Fill Type of the icon is set to texture. Choose an option from the drop-down list.
Data type: Enumeration |
| Width | Specifies the width of the icon. Type a numeric value to change the width.
Data type: Float |
Web Report Studio and JDashboard do not support underlining chart text so this property will be ignored when the chart runs in Web Report Studio or is used in a dashboard.
Back to top