Chart Legend Properties
This topic describes the properties of a Chart Legend object.
Designer provides some properties only when you use the object in certain report types. You can get details from the Available For column in the property table.
Property Name | Available For | Description |
---|---|---|
General | ||
Class Type | Query Page Report | Shows the class type of the object. Read only. |
Data Inherit | Query Page Report | Shows whether the object inherits dataset from another object. Read only. |
Dataset | Query Page Report | Shows the dataset the object applies. Read only. |
Instance Name | Query Page Report | Shows the instance name of the object. 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 legend's top left corner, relative to the chart platform. Type a numeric value to change the coordinate.
Data type: Float This property takes effect when you set the legend's Placement property to "customized". |
Y | Page Report, Web Report, Library Component | Specifies the vertical coordinate of the legend's top left corner, relative to the chart platform. Type a numeric value to change the coordinate.
Data type: Float This property takes effect when you set the legend's Placement property to "customized". |
CSS | ||
Class | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | Specifies the style you want to apply to the object. You can specify the style in two ways:
Data type: String |
Accessibility | ||
External CSS Class Selector | Query Page Report | Specifies the name of the Class Selector for the object in the HTML output. Data type: String |
Legend | ||
Auto Size | Page Report, Web Report, Library Component | Specifies whether to automatically resize the legend according to its content.
Data type: Boolean |
Bottom Margin | Page Report, Web Report, Library Component | Specifies the distance between the legend entry labels and 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 (without the locale part) you want to apply to the object for NLS use.
For example, if the data mapping file is Product_de_DE.properties, type Product in the value cell. Data type: String |
Label Format Source | Page Report, Web Report, Library Component | Specifies the source for the data format of the legend entry labels. Choose an option from the drop-down list.
Designer does not provides this property for heat maps that use only summary as the color-by field. Data type: Enumeration |
Label Horizontal Spacing | Page Report, Web Report, Library Component | Specifies the horizontal distance between two adjacent entry labels in the legend. Type a numeric value to change the distance.
Designer does not provides this property for heat maps that use only summary as the color-by field. Data type: Float |
Label Vertical Spacing | Page Report, Web Report, Library Component | Specifies the vertical distance between two adjacent entry labels in the legend. Type a numeric value to change the distance.
Designer does not provides this property for heat maps that use only summary as the color-by field. Data type: Float |
Left Margin | Page Report, Web Report, Library Component | Specifies the distance between the legend entry 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 entry labels, when you set Label Format Source to "Legend Data Format". Select 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, or 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 entry 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 alignment of the legend at the position specified by 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 scroll bar in 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 you point to a legend entry 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 entry 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 overflows the labels. Data type: Boolean |
Background (for customizing fill pattern of the legend) | ||
Border Color | Page Report, Web Report, Library Component | Specifies the color for the border of the element. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Border End Caps | Page Report, Web Report, Library Component | Specifies the ending style for the border of the element. Choose an option from the drop-down list.
Data type: Enumeration |
Border Joint | Page Report, Web Report, Library Component | Specifies the joint style for the border of the element. Choose an option from the drop-down list.
Data type: Enumeration |
Border Outlined | Page Report, Web Report, Library Component | Specifies whether to use outline path for the border of the element. Default is to apply fill path.
Data type: Boolean |
Border Style | Page Report, Web Report, Library Component | Specifies the line style for the border of the element. Choose an option from the drop-down list.
Data type: Enumeration |
Border Thickness | Page Report, Web Report, Library Component | Specifies the width for the border of the element. Type a numeric value to change the thickness.
Data type: Float |
Border Transparency | Page Report, Web Report, Library Component | Specifies the transparency for the border of the element, in percent. Type a numeric value to change the transparency.
Data type: Integer |
Border Type | Page Report, Web Report, Library Component | Specifies the type for the border of the element.
Data type: Enumeration |
Border Variable Dash | Page Report, Web Report, Library Component | Specifies whether to resize the dash automatically when you select a dash line style for Border Style. Default is to apply fixed dash size. Data type: Boolean |
Color | Page Report, Web Report, Library Component | Specifies the color to fill the element, when you set Fill Type of the element to "color". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Fill Transparency | Page Report, Web Report, Library Component | Specifies the transparency for the fill pattern of the element, in percent. Type a numeric value to change the transparency.
Data type: Integer |
Fill Type | Page Report, Web Report, Library Component | Specifies how you want to fill the element, by color, texture, gradient, or image, or not to fill it. Choose an option from the drop-down list.
Data type: Enumeration |
Gradient End Color | Page Report, Web Report, Library Component | Specifies the ending color of the gradient, when you set Fill Type of the element to "gradient". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Gradient End X | Page Report, Web Report, Library Component | Specifies the horizontal position where the gradient ends when you set Fill Type of the element to "gradient", measured in a percentage of the element's width or the width of the inset in the element if you define an inset, from the left edge of the element or inset.
Data type: Integer |
Gradient End Y | Page Report, Web Report, Library Component | Specifies the vertical position where the gradient ends when you set Fill Type of the element to "gradient", measured in a percentage of the element's height or the height of the inset in the element if you define an inset, from the bottom edge of the element or inset.
Data type: Integer |
Gradient Start Color | Page Report, Web Report, Library Component | Specifies the starting color of the gradient, when you set Fill Type of the element to "gradient". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Gradient Start X | Page Report, Web Report, Library Component | Specifies the horizontal position where the gradient begins when you set Fill Type of the element to "gradient", measured in a percentage of the element's width or the width of the inset in the element if you define an inset, from the left edge of the element or inset.
Data type: Integer |
Gradient Start Y | Page Report, Web Report, Library Component | Specifies the vertical position where the gradient begins when you set Fill Type of the element to "gradient", measured in a percentage of the element's height or the height of the inset in the element if you define an inset, from the bottom edge of the element or inset.
Data type: Integer |
Gradient Style | Page Report, Web Report, Library Component | Specifies the style of the gradient to fill the element, when you set Fill Type of the element 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 you want to use to fill the element, when you set Fill Type of the element to "image". Type the file name with suffix in the value cell. If the image is outside the current catalog, you should include the full path of the image correctly.
Data type: String |
Image Height | Page Report, Web Report, Library Component | You can use the four properties, Image Height, Image Width, Image X, and Image Y, to define a portion of an image (the portion is a rectangle) to fill the element, when you set Fill Type of the element to "image".
Image Height specifies the height of the portion, measured in a percentage of the image's height. Data type: Integer |
Image Layout | Page Report, Web Report, Library Component | Specifies the layout of the image portion to fill the element, when you set Fill Type of the element to "image". Choose an option from the drop-down list.
Data type: Enumeration |
Image Width | Page Report, Web Report, Library Component | You can use the four properties, Image Height, Image Width, Image X, and Image Y, to define a portion of an image (the portion is a rectangle) to fill the element, when you set Fill Type of the element to "image".
Image Width specifies the width of the portion, measured in a percentage of the image's width. Data type: Integer |
Image X | Page Report, Web Report, Library Component | You can use the four properties, Image Height, Image Width, Image X, and Image Y, to define a portion of an image (the portion is a rectangle) to fill the element, when you set Fill Type of the element to "image".
Image X specifies the left position of the portion, measured in a percentage of the image's width, from the left edge of the image. Data type: Integer |
Image Y | Page Report, Web Report, Library Component | You can use the four properties, Image Height, Image Width, Image X, and Image Y, to define a portion of an image (the portion is a rectangle) to fill the element, when you set Fill Type of the element to "image".
Image Y specifies the top position of the portion, measured in a percentage of the image's height, from the bottom edge of the image. Data type: Integer |
Inset Bottom | Page Report, Web Report, Library Component | You can use the four properties, Inset Bottom, Inset Left, Inset Right, and Inset Top, to define an inset in the element and fill the inset instead of the entire element.
Inset Bottom specifies the bottom position of the inset, measured in a percentage of the element's height, from the bottom edge of the element. Data type: Float |
Inset Left | Page Report, Web Report, Library Component | You can use the four properties, Inset Bottom, Inset Left, Inset Right, and Inset Top, to define an inset in the element and fill the inset instead of the entire element.
Inset Left specifies the left position of the inset, measured in a percentage of the element's width, from the left edge of the element. Data type: Float |
Inset Right | Page Report, Web Report, Library Component | You can use the four properties, Inset Bottom, Inset Left, Inset Right, and Inset Top, to define an inset in the element and fill the inset instead of the entire element.
Inset Right specifies the right position of the inset, measured in a percentage of the element's width, from the right edge of the element. Data type: Float |
Inset Top | Page Report, Web Report, Library Component | You can use the four properties, Inset Bottom, Inset Left, Inset Right, and Inset Top, to define an inset in the element and fill the inset instead of the entire element.
Inset Top specifies the top position of the inset, measured in a percentage of the element's height, from the top edge of the element. Data type: Float |
Texture Background Color | Page Report, Web Report, Library Component | Specifies the background color of the texture, when you set Fill Type of the element to "texture". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Texture Foreground Color | Page Report, Web Report, Library Component | Specifies the foreground color of the texture, when you set Fill Type of the element to "texture". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Texture Style | Page Report, Web Report, Library Component | Specifies the style of the texture to fill the element, when you set Fill Type of the element to "texture". Choose an option from the drop-down list.
Data type: Enumeration |
Label (for customizing the legend entry labels) | ||
Auto Scale in Number | Page Report, Web Report, Library Component | Designer displays this property when the legend entry labels show Number values. You can use it to specify 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 to fill the element, when you set Fill Type of the element to "color". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Fill Transparency | Page Report, Web Report, Library Component | Specifies the transparency for the fill pattern of the element, in percent. Type a numeric value to change the transparency.
Data type: Integer |
Fill Type | Page Report, Web Report, Library Component | Specifies how you want to fill the element, by color, texture, or gradient, or not to fill it. Choose an option from the drop-down list.
Data type: Enumeration |
Font Effect | Page Report, Web Report, Library Component | Specifies the special effect of 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 of 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 the label text around its center, in degrees. Type a numeric value to change the rotation. Data type: Float |
Font Script | Page Report, Web Report, Library Component | Specifies to apply superscript or subscript formatting to the label text, 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 the label text around its center. Type a numeric value to change the shearing. Data type: Float |
Font Size | Page Report, Web Report, Library Component | Specifies the font size of 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 to draw through the label text. Choose an option from the drop-down list. Data type: Enumeration |
Font Style | Page Report, Web Report, Library Component | Specifies the font style of 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. "patterned line" or "bold patterned" draws a line or bold line in the pattern of the text.
Data type: Enumeration 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. |
Gradient End Color | Page Report, Web Report, Library Component | Specifies the ending color of the gradient, when you set Fill Type of the element to "gradient". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Gradient End X | Page Report, Web Report, Library Component | Specifies the horizontal position where the gradient ends when you set Fill Type of the element to "gradient", measured in a percentage of the element's width, from the left edge of the element.
Data type: Integer |
Gradient End Y | Page Report, Web Report, Library Component | Specifies the vertical position where the gradient ends when you set Fill Type of the element to "gradient", measured in a percentage of the element's height, from the bottom edge of the element.
Data type: Integer |
Gradient Start Color | Page Report, Web Report, Library Component | Specifies the starting color of the gradient, when you set Fill Type of the element to "gradient". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Gradient Start X | Page Report, Web Report, Library Component | Specifies the horizontal position where the gradient begins when you set Fill Type of the element to "gradient", measured in a percentage of the element's width, from the left edge of the element.
Data type: Integer |
Gradient Start Y | Page Report, Web Report, Library Component | Specifies the vertical position where the gradient begins when you set Fill Type of the element to "gradient", measured in a percentage of the element's height, from the bottom edge of the element.
Data type: Integer |
Gradient Style | Page Report, Web Report, Library Component | Specifies the style of the gradient to fill the element, when you set Fill Type of the element to "gradient". Choose an option from the drop-down list.
Data type: Enumeration |
Outline Color | Page Report, Web Report, Library Component | Specifies the color of the text outline, when you set Font Effect to "outlined" or "shadowed & outlined". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Outline End Caps | Page Report, Web Report, Library Component | Specifies the ending style of the text outline, when you set Font Effect to "outlined" or "shadowed & outlined". Choose an option from the drop-down list.
Data type: Enumeration |
Outline Joint | Page Report, Web Report, Library Component | Specifies the joint style of the text outline, when you set Font Effect to "outlined" or "shadowed & outlined". Choose an option from the drop-down list.
Data type: Enumeration |
Outline Outlined | Page Report, Web Report, Library Component | Specifies whether to use outline path for the text outline, when you set Font Effect to "outlined" or "shadowed & outlined". Default is to apply fill path.
Data type: Boolean |
Outline Style | Page Report, Web Report, Library Component | Specifies the style of the text outline, when you set Font Effect to "outlined" or "shadowed & outlined". Choose an option from the drop-down list. Data type: Enumeration |
Outline Thickness | Page Report, Web Report, Library Component | Specifies the width of the text outline, when you set Font Effect to "outlined" or "shadowed & outlined". Type a numeric value to change the thickness. Data type: Float |
Outline Transparency | Page Report, Web Report, Library Component | Specifies the transparency of the text outline, when you set Font Effect to "outlined" or "shadowed & outlined". 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 when you select a dash line style for Outline Style. Default is to apply fixed dash size. Data type: Boolean |
Percent Format | Page Report, Web Report, Library Component | Specifies the format of the percentage values in the legend entry labels, when you set Show Percent 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 sequence of the legend entry labels.
Data type: Boolean |
Show All Labels | Page Report, Web Report, Library Component | Specifies whether to display entry labels for zero and null values in the legend, besides labels for other values.
Data type: Boolean |
Show Percent | Page Report, Web Report, Library Component | Specifies whether to show the percentage of each legend entry value to the total in the entry labels. Data type: Boolean This property dose not take effect for combo charts, or heat map, bubble, scatter, stock, or surface charts, or when the legend shows range colors such as in an indicator chart. |
Show Values | Page Report, Web Report, Library Component | Specifies whether to show values in the legend entry labels. Data type: Boolean This property dose not take effect for combo charts, or heat map, bubble, scatter, stock, or surface charts, or when the legend shows range colors such as in an indicator chart. |
Text of Total Value | Page Report, Web Report, Library Component | Specifies the text of the entry label that represents the total value in the legend. Data type: String This property dose not take effect for combo charts, or heat map, bubble, scatter, stock, or surface charts, or when the legend shows range colors such as in an indicator chart. |
Texture Background Color | Page Report, Web Report, Library Component | Specifies the background color of the texture, when you set Fill Type of the element to "texture". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Texture Foreground Color | Page Report, Web Report, Library Component | Specifies the foreground color of the texture, when you set Fill Type of the element to "texture". Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Texture Style | Page Report, Web Report, Library Component | Specifies the style of the texture to fill the element, when you set Fill Type of the element to "texture". Choose an option from the drop-down list.
Data type: Enumeration |
Value Format | Page Report, Web Report, Library Component | Specifies the format of the number values in the legend entry labels, when you set Show Values 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 wrap the text according to the width of the legend entry labels. If the text contains special characters (such as ",", ".", and space), it wraps at the position of one of the characters.
Data type: Boolean |
Icon (for customizing the legend entry marks) | ||
Border Color | Page Report, Web Report, Library Component | Specifies the color for the border of the element. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
Border End Caps | Page Report, Web Report, Library Component | Specifies the ending style for the border of the element. Choose an option from the drop-down list.
Data type: Enumeration |
Border Joint | Page Report, Web Report, Library Component | Specifies the joint style for the border of the element. Choose an option from the drop-down list.
Data type: Enumeration |
Border Outlined | Page Report, Web Report, Library Component | Specifies whether to use outline path for the border of the element. Default is to apply fill path.
Data type: Boolean |
Border Style | Page Report, Web Report, Library Component | Specifies the line style for the border of the element. Choose an option from the drop-down list.
Data type: Enumeration |
Border Thickness | Page Report, Web Report, Library Component | Specifies the width for the border of the element. Type a numeric value to change the thickness.
Data type: Float |
Border Transparency | Page Report, Web Report, Library Component | Specifies the transparency for the border of the element, 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 when you select a dash line style for Border Style. Default is to apply fixed dash size. Data type: Boolean |
Height | Page Report, Web Report, Library Component | Specifies the height of the legend entry marks. Type a numeric value to change the height.
Data type: Float |
Icon Alignment | Page Report, Web Report, Library Component | Specifies the relative position of the entry marks in 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 entry mark and entry label. Type a numeric value to change the gap.
Data type: Float |
Width | Page Report, Web Report, Library Component | Specifies the width of the legend entry marks. Type a numeric value to change the width.
Data type: Float |