Index

Chart Legend

Chart legend is a box to identify the patterns or colors assigned to the data series or categories in a chart. You use the properties listed in the following table to control the appearances or behaviors of a chart legend object.

The properties for chart legend are:

Property Description Editable Formula Control Data Type
General
ClassType Shows the class type of the legend object. N N -
Geometry
X The distance between the legend and the left edge of the chart platform that contains it. Y N Float
Y The distance between the legend and the top edge of the chart platform that contains it. Y N Float
Width The width of the legend object. Y N Float
Height The height of the legend object. Y N Float
Legend
HideCategory Specifies whether the category names are shown. Y Y Boolean
HideSeries Specifies whether the series names are shown. Y Y Boolean
Layout Specifies the location of the legend object. Y N Integer
AutoSize Specifies whether to show all the labels of chart legend. Y Y Boolean
TopBottomMinGap The minimum vertical distance between the legend labels. Y Y Integer
LeftRightMinGap The minimum horizontal distance between the legend labels. Y Y Integer
RowColumnMinGap The minimum distance between series name labels and category name labels. Y Y Integer
LabelWidth The width of the legend labels. Y Y Integer
LabelHeight The height of the legend labels. Y Y Integer
TextAlignment Specifies how text is aligned in an object. More Info Y N Integer
IconAlignment Specifies how icon is aligned in an object. More Info Y N Integer
LabelVSpacing The vertical distance between legend labels, in pixels. The default value is -1 (Not Set). Y Y Integer
LabelHSpacing The horizontal distance between legend labels, in pixels. The default value is -1 (Not Set). Y Y Integer
BorderStyle Specifies the border style for an object. More Info Y N Integer
PenStyle Specifies the style for the pen object. More Info Y N Integer
PenColor The color for the pen object. Y Y String
PenThickness The thickness for the pen object. More Info Y N Float
EndCaps Specifies the ending style for the pen object. More Info Y N Integer
LineJoint Specifies the line joint style for the pen object. More Info Y N Integer
Outline Specifies whether an object is shown in outline form. Y N Boolean
VariabledDash Specifies whether the dash is auto-sized. Y N Boolean
BorderTransparency The border transparency, in percent. Y Y Integer
BackgroundTransparency The fill transparency, in percent. Y Y Integer
FillPattern Specifies a fill pattern for an object. More Info Y N Integer
Top The top position of the background area, measured in the percentage of the object's height, from the top edge of the object, used together with Left, Right, and Bottom. Y N Integer
Left The left position of the background area, measured in the percentage of the object's width, from the left edge of the object, used together with Top, Right, and Bottom Y N Integer
Right The right position of the background area, measured in the percentage of the object's width, from the right edge of the object, used together with Top, Left, and Bottom. Y N Integer
Bottom The bottom position of the background area, measured in the percentage of the object's height, from the bottom edge of the object, used together with Top, Left, and Right. Y N Integer
BackgroundColor The color for the background. Y Y String
TextureStyle Specifies a texture style for an object. More Info Y N Integer
TextureForeColor The color for the texture foreground. Y Y String
TextureBackColor The color for the texture background. Y Y String
GradientStyle Specifies a gradient style for an object. More Info Y N Integer
GradientStartColor The color for the gradient first color. Y Y String
GradientEndColor The color for the gradient second color. Y Y String
GradientStartX The horizontal position, measured in the percentage of the object's width, from the left edge of the object, where the gradient starts. Y Y Integer
GradientStartY The vertical position, measured in the percentage of the object's height, from the bottom edge of the object, where the gradient starts. Y Y Integer
GradientEndX The horizontal position, measured in the percentage of the object's width, from the left edge of the object, where the gradient ends. Y Y Integer
GradientEndY The vertical position, measured in the percentage of the object's height, from the bottom edge of the object, where the gradient ends. Y Y Integer
Image Specifies a gif image to display on an object. Y Y String
ImageLayout Specifies a layout style for the image. More Info Y N Integer
ImageX The left position of the image, measured in the percentage of the object's width, from the left edge of the object. Y Y Integer
ImageY The top position of the image, measured in the percentage of the object's height, from the bottom edge of the object. Y Y Integer
ImageWidth The width of the image, measured in the percentage of the object's width. Setting this value to less than 100 percent will cut the image from the right edge. Y Y Integer
ImageHeight The height of the image, measured in the percentage of the object's height. Setting this value to less than 100 percent will cut the image from the bottom edge. Y Y Integer
LabelFilterSource Specifies the data filter the chart legend label uses. The default value is AxisDataFilter. Y N Integer
Group1LabelFilter Specifies the content of group1 label (Available when the LabelFilterSource is set to LegendDataFilter). More Info Y N String
Group2LabelFilter Sepcifies the content of group2 label (Available when the LabelFilerSource is set to LegendDataFilter). More Info Y N String
ReverseGroup1Labels Specifies whether to reverse the order of the group1 labels. The default value is false. Y Y Boolean
Icon
IconStyleList Specifies the style for the icon of each category name. The icon style for each category name can be different. More Info Y Y String
SeriesIconStyle Specifies a style for the icons of the data series name. More Info Y N Integer
IconWidth The width of legend icons. Y Y Integer
IconHeight The height of legend icons. Y Y Integer
IconPenStyle Specifies the style for the pen object. More Info Y N Integer
IconPenColor The color for the pen object. Y Y String
IconPenThickness The thickness for the pen object. More Info Y N Float
IconEndCaps Specifies the ending style for the pen object. More Info Y N Integer
IconLineJoint Specifies the line joint style for the pen object. More Info Y N Integer
IconOutline Specifies whether an object is shown in outline form. Y N Boolean
IconVariabledDash Specifies whether the dash is auto-sized. Y N Boolean
IconBorderTransparency The border transparency, in percent. Y Y Integer
IconFillPattern Specifies a fill pattern for an object. More Info Y N Integer
IconBackgroundTransparency The fill transparency, in percent. Y Y Integer
IconBackgroundColor The color for the background. Y Y String
IconTextureStyle Specifies a texture style for an object. More Info Y N Integer
IconTextureForeColor The color for the texture foreground. Y Y String
IconTextureBackColor The color for the texture background. Y Y String
IconGradientStyle Specifies a gradient style for an object. More Info Y N Integer
IconGradientStartColor The color for the gradient first color. Y Y String
IconGradientEndColor The color for the gradient second color. Y Y String
IconGradientStartX The horizontal position, measured in the percentage of the object's width, from the left edge of the object, where the gradient starts. Y Y Integer
IconGradientStartY The vertical position, measured in the percentage of the object's height, from the bottom edge of the object, where the gradient starts. Y Y Integer
IconGradientEndX The horizontal position, measured in the percentage of the object's width, from the left edge of the object, where the gradient ends. Y Y Integer
IconGradientEndY The vertical position, measured in the percentage of the object's height, from the bottom edge of the object, where the gradient ends. Y Y Integer
Font
FontFace Specifies a font for an object. Y Y String
FontStyle Specifies a font style for an object. More Info Y N Integer
FontUnderline Specifies the style of the horizontal line under text. More Info Y N Integer
FontStrikeThrough Specifies the style of the horizontal line with which the font is struck through. More Info Y N Integer
FontSize Specifies the font size for an object. Y N Float
FontShearing Specifies the shearing transformation of an object around its center. The default value is 0, range from -200 ~200. Y Y Integer
FontRotation Specifies the font rotation of an object around its center, in degrees. The default value is 0. Y Y Integer
FontSpecialEffect1 Specifies special effect for the font. More Info Y N Integer
FontSpecialEffect2 Specifies special effect for the font. More Info Y N Integer
FontPenStyle Specifies the style for the pen object. More Info Y N Integer
FontPenColor The color for the pen object. Y Y String
FontPenEndCaps Specifies the ending style for the pen object. More Info Y N Integer
FonePenLineJoint Specifies the line joint style for the pen object. More Info Y N Integer
FontPenOutline Specifies whether an object is shown in outline form. Y N Boolean
FontPenVariabledDash Specifies whether the dash is auto-sized. Y N Boolean
FontPenTransparency The border transparency, in percent. Y Y Integer
FontFillPattern Specifies a fill pattern for an object. More Info Y N Integer
FontTransparency The fill transparency, in percent. Y Y Integer
FontColor The color for the background. Y Y String
FontTextureStyle Specifies a texture style for an object. More Info Y N Integer
FontTextureForeColor The color for the texture foreground. Y Y String
FontTextureBackColor The color for the texture background. Y Y String
FontGradientStyle Specifies a gradient style for an object. More Info Y N Integer
FontGradientStartColor The color for the gradient first color. Y Y String
FontGradientEndColor The color for the gradient second color. Y Y String
FontGradientStartX The horizontal position, measured in the percentage of the object's width, from the left edge of the object, where the gradient starts. Y Y Integer
FontGradientStartY The vertical position, measured in the percentage of the object's height, from the bottom edge of the object, where the gradient starts. Y Y Integer
FontGradientEndX The horizontal position, measured in the percentage of the object's width, from the left edge of the object, where the gradient ends. Y Y Integer
FontGradientEndY The vertical position, measured in the percentage of the object's height, from the bottom edge of the object, where the gradient ends. Y Y Integer

Index