Previous Topic
Chart Legend Properties
This topic lists the properties of a Chart Legend object. The availabilities of the properties vary for the supported report types: Page Report, Web Report and Library Component.
| Property Name | Available For | Description |
|---|---|---|
| General | ||
| Class Type | Query Page Report | Indicates the class type of the object. This property is read only. |
| Data Inherit | Query Page Report | Indicates whether the dataset for this object is inherited from another object. This property is read only. |
| Dataset | Query Page Report | Indicates the dataset used by the object. This property is read only. |
| Instance Name | Query Page Report | Shows the instance name of the object. This property is read only. |
| Geometry | ||
| Height | Page Report, Web Report, Library Component | Specifies the height of the object. Type a numeric value to change the height.
Data type: Float |
| Width | Page Report, Web Report, Library Component | Specifies the width of the object. Type a numeric value to change the width.
Data type: Float |
| X | Page Report, Web Report, Library Component | 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. This property takes effect only when the Placement property is set to customized.
Data type: Float |
| Y | Page Report, Web Report, Library Component | 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. This property takes effect only when the Placement property is set to customized.
Data type: Float |
| CSS | ||
| Class | Page Report, Web Report, Library Component | Specifies a CSS class to be applied to the object which is a valid class in the CSS file.
Data type: String |
| Style | Page Report, Web Report, Library Component | The property can be used in two ways.
Data type: String |
| Accessibility | ||
| External CSS Class Selector | Query Page Report | Specifies a class selector to be applied to the object when exported as HTML. Type a valid class name from the CSS file.
Data type: String |
| Legend | ||
| Auto Size | Page Report, Web Report, Library Component | Specifies whether to resize the legend automatically.
Data type: Boolean |
| Bottom Margin | Page Report, Web Report, Library Component | Specifies the distance between the legend labels and the bottom border of the legend. Type a numeric value to change the margin.
Data type: Float |
| Data Mapping File | Page Report, Web Report, Library Component | Specifies the data mapping file to the object for NLS use.
For example, if the data mapping file name is Category_de_DE.properties, set the value as Category (without the language and locale part). Data type: String |
| Label Format Source | Page Report, Web Report, Library Component | Specifies the data format option for the chart legend labels. Choose an option from the drop-down list.
Not available to heat maps that are colored only by summaries. Data type: Enumeration |
| Label Horizontal Spacing | Page Report, Web Report, Library Component | Specifies the horizontal distance between two adjacent legend labels. Type a numeric value to change the distance.
Not available to heat maps that are colored only by summaries. Data type: Float |
| Label Vertical Spacing | Page Report, Web Report, Library Component | Specifies the vertical distance between two adjacent legend labels. Type a numeric value to change the distance.
Not available to heat maps that are colored only by summaries. Data type: Float |
| Left Margin | Page Report, Web Report, Library Component | Specifies the distance between the legend labels and the left border of the legend. Type a numeric value to change the margin.
Data type: Float |
| Legend Data Format | Page Report, Web Report, Library Component | Specifies the data format of the legend labels. Applied when Label Format Source is set to Legend Data Format. Select the ellipsis button  in the value cell to specify the format in the Data Format dialog box.
Data type: String |
| Placement | Page Report, Web Report, Library Component | Specifies the position of the legend to be on the left, right, top, bottom of the chart or customized by manually dragging on the chart. Choose an option from the drop-down list.
Data type: Enumeration |
| Right Margin | Page Report, Web Report, Library Component | Specifies the distance between the legend labels and the right border of the legend. Type a numeric value to change the margin.
Data type: Float |
| Secondary Placement | Page Report, Web Report, Library Component | Specifies the position of the legend further based on the setting of the property Placement. Choose an option from the drop-down list.
Data type: Enumeration |
| Show Scrollbar | Page Report, Web Report, Library Component | Specifies whether to show a scrollbar on the legend to fully view the legend content when the content does not fit into the legend.
Data type: Boolean |
| Show Tips | Page Report, Web Report, Library Component | Specifies whether to show the corresponding data information when the mouse pointer points at a legend entry in the chart in Designer view mode, in HTML output, or at runtime.
Data type: Boolean |
| Top Margin | Page Report, Web Report, Library Component | Specifies the distance between the legend labels and the top border of the legend. Type a numeric value to change the margin.
Data type: Float |
| Truncate | Page Report, Web Report, Library Component | Specifies whether to truncate the legend entry label text when the text overflow the labels.
Data type: Boolean |
| Background | ||
| Border Color | Page Report, Web Report, Library Component | Specifies the color of the legend 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 | Page Report, Web Report, Library Component | Specifies the ending style of the legend border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Joint | Page Report, Web Report, Library Component | Specifies the joint style of the legend border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Outlined | Page Report, Web Report, Library Component | Specifies whether to show the legend border line in Outline Path. If the property is set to true, the legend border line will be shown in Outline Path; otherwise, in Fill Path.
Data type: Boolean |
| Border Style | Page Report, Web Report, Library Component | Specifies the line style of the legend border. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Thickness | Page Report, Web Report, Library Component | Specifies the width of the legend border. Type a numeric value to change the thickness.
Data type: Float |
| Border Transparency | Page Report, Web Report, Library Component | Specifies the transparency of the legend border, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Border Type | Page Report, Web Report, Library Component | Specifies the border type of the legend. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Variable Dash | Page Report, Web Report, Library Component | Specifies whether to resize the dash automatically.
Data type: Boolean |
| Color | Page Report, Web Report, Library Component | Specifies the color of the legend background. Applied when Fill Type of the legend 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 | Page Report, Web Report, Library Component | Specifies the transparency of the legend background, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Fill Type | Page Report, Web Report, Library Component | Specifies the fill pattern for the legend background. Choose an option from the drop-down list. Can be none, color, texture, gradient or image.
Data type: Enumeration |
| Gradient End Color | Page Report, Web Report, Library Component | Specifies the color of the point where the gradient ends. Applied when Fill Type of the legend 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 | Page Report, Web Report, Library Component | Specifies the horizontal position where the gradient ends, measured in a percentage of the legend width. Applied when Fill Type of the legend background is set to gradient.
Data type: Integer |
| Gradient End Y | Page Report, Web Report, Library Component | Specifies the vertical position where the gradient ends, measured in a percentage of the legend height. Applied when Fill Type of the legend background is set to gradient.
Data type: Integer |
| Gradient Start Color | Page Report, Web Report, Library Component | Specifies the color of the point where the gradient begins. Applied when Fill Type of the legend 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 | Page Report, Web Report, Library Component | Specifies the horizontal position where the gradient begins, measured in a percentage of the legend width. Applied when Fill Type of the legend background is set to gradient.
Data type: Integer |
| Gradient Start Y | Page Report, Web Report, Library Component | Specifies the vertical position where the gradient begins, measured in a percentage of the legend height. Applied when Fill Type of the legend background is set to gradient.
Data type: Integer |
| Gradient Style | Page Report, Web Report, Library Component | Specifies the gradient style for the legend background. Applied when Fill Type of the legend background is set to gradient. Choose an option from the drop-down list.
Data type: Enumeration |
| Image File | Page Report, Web Report, Library Component | Specifies the file name of the image, a portion of which will be displayed as the legend background. Applied when Fill Type of the legend 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 | Page Report, Web Report, Library Component | 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 legend background. They take effect when Fill Type of the legend 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 | Page Report, Web Report, Library Component | Specifies the layout style for the image that will be displayed as the legend background. Applied when Fill Type of the legend background is set to image. Choose an option from the drop-down list.
Data type: Enumeration |
| Image Width | Page Report, Web Report, Library Component | 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 legend background. They take effect when Fill Type of the legend 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 | Page Report, Web Report, Library Component | 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 legend background. They take effect when Fill Type of the legend 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 | Page Report, Web Report, Library Component | 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 legend background. They take effect when Fill Type of the legend 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 | Page Report, Web Report, Library Component | Specifies the bottom position of the background area, measured in a percentage of the legend height, from the bottom edge of the legend.
Data type: Float |
| Inset Left | Page Report, Web Report, Library Component | Specifies the left position of the background area, measured in a percentage of the legend width, from the left edge of the legend.
Data type: Float |
| Inset Right | Page Report, Web Report, Library Component | Specifies the right position of the background area, measured in a percentage of the legend width, from the right edge of the legend.
Data type: Float |
| Inset Top | Page Report, Web Report, Library Component | Specifies the top position of the background area, measured in a percentage of the legend height, from the top edge of the legend.
Data type: Float |
| Texture Background Color | Page Report, Web Report, Library Component | Specifies the background color of the texture. Applied when Fill Type of the legend 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 | Page Report, Web Report, Library Component | Specifies the foreground color of the texture. Applied when Fill Type of the legend 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 | Page Report, Web Report, Library Component | Specifies the texture style of the legend background. Applied when Fill Type of the legend background is set to texture. Choose an option from the drop-down list.
Data type: Enumeration |
| Label | ||
| Auto Scale in Number | Page Report, Web Report, Library Component | The property is available when the legend entry values are of the Number data type. It specifies whether to automatically scale the values that fall into the two ranges:
The option "auto" means that the property setting follows that of the chart. Data type: Boolean |
| Color | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | Specifies the transparency of the label text, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Fill Type | Page Report, Web Report, Library Component | 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: Enumeration |
| Font Effect | Page Report, Web Report, Library Component | Specifies the special effect for the label text. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Face | Page Report, Web Report, Library Component | Specifies the font face for the label text. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Rotation | Page Report, Web Report, Library Component | Specifies the rotation angle of each legend label around its center, in degrees. The default value is 0. Type a numeric value to change the rotation.
Data type: Float |
| Font Script | Page Report, Web Report, Library Component | Specifies whether the label text will in superscript or subscript form, or neither of them. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Shearing | Page Report, Web Report, Library Component | Specifies the shearing transformation of each legend label around its center. The default value is 0. Type a numeric value to change the shearing.
Data type: Float |
| Font Size | Page Report, Web Report, Library Component | Specifies the font size for the label text. Type an integer value to change the size.
Data type: Integer |
| Font Strikethrough | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | Specifies the font style for the label text. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Underline | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | Specifies the gradient style for the label. Applied when Fill Type of the label text is set to gradient. The image fill type does not apply to the legend label. Choose an option from the drop-down list.
Data type: Enumeration |
| Outline Color | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | Specifies the ending style for the label text outline. Choose an option from the drop-down list.
Data type: Enumeration |
| Outline Joint | Page Report, Web Report, Library Component | Specifies the joint style for the label text outline. Choose an option from the drop-down list..
Data type: Enumeration |
| Outline Outlined | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | Specifies the style for the label text outline. Choose an option from the drop-down list.
Data type: Enumeration |
| Outline Thickness | Page Report, Web Report, Library Component | Specifies the thickness for the label text outline. Type a numeric value to change the thickness.
Data type: Float |
| Outline Transparency | Page Report, Web Report, Library Component | Specifies the transparency for the label text outline, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Outline Variable Dash | Page Report, Web Report, Library Component | 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 |
| Percent Format | Page Report, Web Report, Library Component | Specifies the format of the percentage values on the legend. Applied when Show Percent is set to true. Select in the value cell to specify the format in the Data Format dialog box.
Data type: String |
| Reverse Labels | Page Report, Web Report, Library Component | Specifies whether to reverse the order of the labels on the legend.
Data type: Boolean |
| Show Percent | Page Report, Web Report, Library Component | Specifies whether to show the percentage of each entry value to the total on the legend. Applies to pie, bar and bench charts that have only one value axis.
Data type: Boolean |
| Show Values | Page Report, Web Report, Library Component | Specifies whether to show the values for the legend entries. Applies to pie, bar and bench charts that have only one value axis.
Data type: Boolean |
| Text of Total Value | Page Report, Web Report, Library Component | Specifies the text of the total value label on the legend. Applies to pie, bar and bench charts that have only one value axis.
Data type: String |
| Texture Background Color | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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 |
| Value Format | Page Report, Web Report, Library Component | Specifies the number format of the legend entry values. Applied when Show Values is set to true. Select in the value cell to specify the format in the Data Format dialog box.
Data type: String |
| Word Wrap | Page Report, Web Report, Library Component | 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 |
| Icon | ||
| Border Color | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | Specifies the ending style of the icon border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Joint | Page Report, Web Report, Library Component | Specifies the joint style of the icon border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Outlined | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | Specifies the line style of the icon border. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Thickness | Page Report, Web Report, Library Component | Specifies the width of the icon border. Type a numeric value to change the thickness.
Data type: Float |
| Border Transparency | Page Report, Web Report, Library Component | Specifies the transparency of the icon borders, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Border Variable Dash | Page Report, Web Report, Library Component | 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 |
| Height | Page Report, Web Report, Library Component | Specifies the height of the icon. Type a numeric value to change the width.
Data type: Float |
| Icon Alignment | Page Report, Web Report, Library Component | Specifies the relative position of the icon to the legend. Choose an option from the drop-down list.
Data type: Enumeration |
| Icon Text Gap | Page Report, Web Report, Library Component | Specifies the distance between each legend label and icon. Type a numeric value to change the gap.
Data type: Float |
| Width | Page Report, Web Report, Library Component | 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.