Skip to main content

Chart Legend Properties

  • Updated

BackPrevious Topic  Next TopicNext

Chart Legend Properties

This topic describes the properties of the Chart Legend object.

PropertyDescription
General
Display NameSpecify the display name of the object.

Data type: String

Instance NameServer displays the instance name of the object. This property is read only.
Geometry
HeightSpecify the height of the object, in inches. Type a numeric value to change the height.

Data type: Float

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

Data type: Float

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

Note icon This property takes effect only when you set the Placement property to customized.

Data type: Float

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

Note icon This property takes effect only when you set the Placement property to customized.

Data type: Float

Legend
Auto SizeSpecify whether to resize the legend automatically.

Data type: Boolean

Bottom MarginSpecify 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 SourceSpecify the data format option for the chart legend labels.
  • Axis Data Format
    Select if you want the data format of the legend labels to follow that of the axis data: if the chart has series axis, the legend label format will be the same as the series axis data format; if not, the legend labels will use the category axis data format.
  • Legend Data Format
    Select if you want to control the data format of the legend labels by the Legend Data Format property.

Note icon This property is not available to heat maps that are colored only by summaries.

Data type: Enumeration

Label Horizontal SpacingSpecify the horizontal distance between two adjacent legend labels. Type a numeric value to change the distance.

Note icon This property is not available to heat maps that are colored only by summaries.

Data type: Float

Label Vertical SpacingSpecify the vertical distance between two adjacent legend labels. Type a numeric value to change the distance.

Note icon This property is not available to heat maps that are colored only by summaries.

Data type: Float

Left MarginSpecify 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 FormatSpecify the data format of the legend labels. Select the ellipsis button Select Values in the value cell to specify the format in the Data Format dialog box.

Note icon This property applies when you set Label Format Source to Legend Data Format.

Data type: String

PlacementSpecify the position of the legend to be on the left, right, top, bottom of the chart or customized by manually dragging in the chart. Choose an option from the drop-down list.

Data type: Enumeration

Right MarginSpecify 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 Specify the position of the legend further based on the setting of the Placement property. Choose an option from the drop-down list.

Data type: Enumeration

Show ScrollbarSpecify whether to display a scroll bar on the legend to fully view the legend contents when the contents do not fit into the legend.

Data type: Boolean

Show TipsSpecify whether to show the corresponding data information when you hover over a legend entry in the chart. The tip is also available in the HTML output.

Data type: Boolean

Top MarginSpecify 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

TruncateSpecify whether to truncate the legend entry label text when the text overflow the labels.

Data type: Boolean

Background
Border ColorSpecify the color of the legend border. Select 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

Data type: String

Border End CapsSelect the ending style of the legend border line.

Data type: Enumeration

Border StyleSelect the line style of the legend border.

Data type: Enumeration

Border ThicknessSpecify the width of the legend border, in inches. Type a numeric value to change the thickness.

Data type: Float

Border TransparencySpecify the color transparency of the legend border, in percent. Type a numeric value to change the transparency.

Data type: Integer

Border TypeSelect the border type of the legend.

Data type: Enumeration

Border Variable DashSelect true to adjust the dash size automatically or false to use the fixed dash size.

Data type: Boolean

ColorSpecify the color of the legend background. Select 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

Note icon This property applies when you set Fill Type of the legend background to Color.

Data type: String

Fill TransparencySpecify the transparency of the legend background color, in percent. Type a numeric value to change the transparency.

Data type: Integer

Fill TypeSpecify the fill pattern for the legend background.
  • None
    No fill. The default value.
  • Color
    Select to fill with a specified color.
  • More Effects
    Select to specify either a gradient or an image as the fill effect in the Fill Effects dialog box.

Data type: Enumeration

Inset BottomSpecify 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 LeftSpecify 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 RightSpecify 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 TopSpecify 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 Select true if you want to automatically scale the values that are of the Number data type when the values fall into the two ranges:
  • When 1000 <= value < 10^15, Logi Report uses the following quantity unit symbols of the International System of Units to scale the values: K (10^3), M (10^6), G (10^9), and T (10^12).
  • When 0 < value < 0.001 or value >= 10^15, Logi Report uses scientific notation to scale the values.

The default value auto means that the setting follows that of the chart.

Data type: Boolean

ColorSpecify the color of the label text. Select 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

Note icon This property applies when you set Fill Type of the label text to Color.

Data type: String

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

Data type: Integer

Fill TypeSpecify the fill pattern for the label text.
  • None
    No fill. The default value.
  • Color
    Select to fill with a specified color.

Data type: Enumeration

Font FaceSelect the font face for the label text.

Data type: Enumeration

Font RotationSpecify 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 SizeSpecify the font size for the label text. Type an integer value to change the size.

Data type: Integer

Font StyleSelect the font style for the label text.

Data type: Enumeration

Outline ColorSpecify the color for the label text outline. Select 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

Data type: String

Outline End CapsSelect the ending style for the label text outline.

Data type: Enumeration

Outline JointSelect the joint style for the label text outline.

Data type: Enumeration

Percent FormatSpecify the format of the percentage values on the legend. Select the ellipsis button Select Values in the value cell to specify the format in the Data Format dialog box.

Note icon This property applies when you set Show Percent to true.

Data type: String

Reverse LabelsSpecify whether to reverse the order of the labels in the legend object.

Data type: Boolean

Show All LabelsSpecify whether to display zero values besides other values in the legend.

Data type: Boolean

Show PercentSpecify whether to show the percentage of each entry value to the total on the legend. This property applies to pie, bar, and bench charts that have only one value axis.

Data type: Boolean

Show ValuesSpecify whether to show the values for the legend entries. This property applies to pie, bar, and bench charts that have only one value axis.

Data type: Boolean

Text of Total ValueSpecify the text of the total value label on the legend. This property applies to pie, bar, and bench charts that have only one value axis.

Data type: String

Value FormatSpecify the number format of the legend entry values. Select the ellipsis button Select Values in the value cell to specify the format in the Data Format dialog box.

Note icon This property applies when you set Show Values to true.

Data type: String

Icon
Border ColorSpecify the color of the icon border. Select 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

Data type: String

Border End CapsSelect the ending style of the icon border line.

Data type: Enumeration

Border JointSelect the joint style of the icon border line.

Data type: Enumeration

Border StyleSelect the line style of the icon border.

Data type: Enumeration

Border ThicknessSpecify the width of the icon border in inches. Type a numeric value to change the thickness.

Data type: Float

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

Data type: Integer

Border Variable DashSelect true to adjust the dash size automatically or false to use the fixed dash size.

Data type: Boolean

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

Data type: Float

Icon AlignmentSelect the relative position of the icon to the legend.

Data type: Enumeration

Icon Text GapSpecify the distance between each legend label and icon. Type a numeric value to change the gap.

Data type: Float

BackPrevious Topic  Next TopicNext

Related articles