Previous Topic
Chart Legend
The properties of the Chart Legend object are:
| Property | 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 top left corner of the object, relative to its parent container. Type a numeric value to change the position in inches.
This property takes effect only when the Placement property is set to customized.
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 in inches.
This property takes effect only when the Placement property is set to customized.
Data type: Float |
| Legend | |
| Auto Size | Specifies whether to resize the legend automatically.
Data type: Boolean |
| Bottom Margin | Specifies the distance between the legend labels and the bottom border of the legend, in inches. Type a numeric value to change the margin.
Data type: Float |
| Label Format Source | Specifies the data format option for the chart legend labels. Choose an option from the drop-down list.
Unavailable to heat maps that are colored only by summaries. Data type: Enumeration |
| Label Horizontal Spacing | Specifies the horizontal distance between two adjacent legend labels. Type a numeric value to change the distance.
Unavailable to heat maps that are colored only by summaries. Data type: Float |
| Label Vertical Spacing | Specifies the vertical distance between two adjacent legend labels. Type a numeric value to change the distance.
Unavailable to heat maps that are colored only by summaries. Data type: Float |
| Left Margin | Specifies the distance between the legend labels and the left border of the legend, in inches. Type a numeric value to change the margin.
Data type: Float |
| Legend Data Format | Specifies the data format of the legend labels. Applied when Label Format Source is set to Legend Data Format. Select  in the value cell to specify the format in the Data Format dialog box.
Data type: String |
| Placement | 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 | Specifies the distance between the legend labels and the right border of the legend, in inches. Type a numeric value to change the margin.
Data type: Float |
| Secondary Placement | 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 | 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 | Specifies whether to show the corresponding data information when the mouse pointer points at a legend entry in the chart. The tip is also available in HTML result。
Data type: Boolean |
| Top Margin | Specifies the distance between the legend labels and the top border of the legend, in inches. Type a numeric value to change the margin.
Data type: Float |
| Truncate | Specifies whether to truncate the legend entry label text when the text overflow the labels.
Data type: Boolean |
| Background | |
| Border Color | Specifies the color of the legend 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 legend border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Style | Specifies the line style of the legend border. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Thickness | Specifies the width of the legend border, in inches. Type a numeric value to change the thickness.
Data type: Float |
| Border Transparency | Specifies the color transparency of the legend border, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Border Type | Specifies the border type of the legend. 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 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 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 legend background color, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Fill Type | Specifies the fill pattern for the legend background. Choose an option from the drop-down list.
Data type: Enumeration |
| Inset Bottom | 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 | 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 | 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 | 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 |
| Label | |
| Auto Scale in Number | Specifies whether to automatically scale the legend entry values that are of the Number data type when the values fall into the two ranges:
The option "auto" means that the property setting follows that of the chart. Data type: Boolean |
| 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.
Data type: Enumeration |
| Font Face | Specifies the font face for the label text. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Rotation | 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 Size | Specifies the font size for 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 |
| Outline Color | Specifies the color for the label text outline. 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 |
| Outline End Caps | Specifies the ending style for the label text outline. Choose an option from the drop-down list.
Data type: Enumeration |
| Outline Joint | Specifies the joint style for the label text outline. Choose an option from the drop-down list.
Data type: Enumeration |
| Percent Format | 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 | Specifies whether to reverse the order of the labels in the legend object.
Data type: Boolean |
| Show Percent | 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 | 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 | 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 |
| Value Format | 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 |
| Icon | |
| Border Color | Specifies the color of the icon borders. 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 Style | Specifies the line style of the icon borders. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Thickness | Specifies the width of the icon borders in inches. Type a numeric value to change the thickness.
Data type: Float |
| Border Transparency | Specifies the color transparency of the icon borders, 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 |
| 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 legend. Choose an option from the drop-down list.
Data type: Enumeration |
| Icon Text Gap | Specifies the distance between each legend label and icon. Type a numeric value to change the gap.
Data type: Float |