Element Details: Legend
 Back


Available in: Logi Info Source code name: ChartCanvasLegendIntroduced in: v11.2.040

Controls the display style of and interactions with a chart legend.

The Legend appears automatically when a Series element has its Legend Label attribute set.



ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
AlignmentHorizontal
Right
Left
Center
Sets the horizontal alignment of the text as "Left", "Center", or "Right".
AlignmentVertical
Top
Middle
Bottom
Sets the vertical alignment of the text as "Top", "Middle", or "Bottom".
BackgroundColor
UserDefined
Transparent
Sets the background color of the element. Enter a color by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, like #112233.
BackgroundColorTransparency
UserDefined
7
15
0
The related Background Color attribute sets the element’s background color. Background Color Transparency adds transparency to that color. The lowest value of “0” specifies that the background is opaque, with no transparency. At the other end of the scale, “15” specifies a completely transparent background. Use medium-level transparency to allow different chart layers to show through each other.
BorderColor
UserDefined
Transparent
Sets the color of border lines. Enter a color by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, like #112233.
BorderColorTransparency
UserDefined
7
15
0
The related Border Color attribute sets the canvas border line color. Border Color Transparency adds transparency to that color. The lowest value of “0” specifies that the border line is opaque, with no transparency. At the other end of the scale, “15” specifies a completely transparent line. Use medium-level transparency to allow different chart layers to show through each other.
BorderRadius
UserDefined
Sets the amount of rounding for canvas, legend, and data label corners, in pixels.
Format
UserDefined
Allows a string to be formatted in various ways, especially for numeric and date values. Specifies formatting characteristics for the data. This attribute has been borrowed from the Microsoft Visual Basic Format function. For more information: http://msdn.microsoft.com/en-us/library/59bz1f0h(VS.71).aspx For dates, the non-specific formats, such as "General Date", "Short Time", etc., are converted according to the browser's international setttings. Also, for very large reports, the non-specific formats perform better. There are also some special formats. "<" and ">" change strings to lower and upper case. "Expanded Spaces" preserves space characters that would otherwise be collapsed by the web browser. "HTML" preserves HTML tags so that they are not encoded - they are embedded rather than shown. "Preserve Line Feeds" preserves line feed and cariage return characters so that the following characters appear on a new line. "mp" formats numbers with the "metric prefix". To format 1,234,567 as "$1.23M", use Format "$#.00mp". Supported metric prefixes are from 1000^6 to 1000^-6 For more information: http://en.wikipedia.org/wiki/Metric_prefix "mpsx" formats the value with x number of significant figures in addition to the metric prefix. So a value of 123456, with format set to mps3 will return 123k. "qq" returns the number of the quarter when the value being formatted represents a date. To return the year and quarter together like "2010 Q1", set the format to "yyyy Qqq". "fyy" and "fyyyy" return the fiscal year. "fqq" returns the fiscal quarter. The fiscal year start date may be configured in the settings' Globalization element. "ww" returns the number of the week. The first day of the week may be configured in the settings' Globalization element.
InsidePlotArea
True
False
Specifies whether space in the canvas will be reserved for this element (“False”) or whether it will overlap other content (“True”). The default value is "False".
LegendBorderThickness
UserDefined
The legend border thickness, in pixels. The default is 1.
LegendCaption
UserDefined
The legend caption/title.
LegendOrientation
Vertical
Horizontal
Specifies whether the legend items are listed vertically or horizontally. The default value is "Vertical".
LegendSpacing
UserDefined
The space between legend and chart plot area, in pixels. The default is 15.
LegendSymbolWidth
UserDefined
Sets the legend item symbol width, in pixels. The default value is 16 pixels.
MaxHeight
UserDefined
The maximum height, in pixels.
OffsetX
UserDefined
Sets the horizontal position offset of the element relative to the horizontal alignment, in pixels.
OffsetY
UserDefined
Sets the vertical position offset of the element relative to the vertical alignment, in pixels.
ReversedItemOrder
True
False
Set to “True” to reverse the order of legend items.
ShowAllCaption
UserDefined
The ShowAllCaption attribute sets the caption for a clickable legend item which either shows or hides all items. The ShowAll link appears when the number of items is not less than the ShowAllThreshold attribute's value. To hide the ShowAll, set ShowAllThreshold to a large number, like 9999. The default is "Show All".
ShowAllThreshold
UserDefined
The ShowAll link appears when the number of items is not less than the ShowAllThreshold attribute's value. To hide the ShowAll, set ShowAllThreshold to a large number, like 9999. The default is "4". When there are 4 or more legend items, the link appears. When less, it does not appear.
Width
UserDefined
The width of the element.



PARENT ELEMENTS

Click element to drill down for more information.

Chart Canvas


CHILD ELEMENTS

Click element to drill down for more information.

Caption Style
Hidden Label Style
Label Hover Style
Label Style
Legend Navigation Style


 Back to top


 Chart Debug