Legend Symbol Option

Draws a legend symbol representing a value or a value set. The size of legend symbol elements cannot be defined, since the symbols always have the same size as the font of the symbol description.

Attributes

  • valueSetIndex
    • defines which value set is to be represented
    • Recommended values: 1,2,…,n with “n” being the number of your value sets. Defining more legend symbols than there are value sets in the chart is possible but they will not be displayed as long as there is no corresponding value set.

Options

  • type
    • defines the shape of a legend symbol
    • Available shapes: circle| square| triangle| diamond| line.
    • default: circle
  • style
    • defines the style used for the symbol
    • Available styles: plain| beveled| 3d.
    • default: plain
  • shadow
    • activates a shadow behind the legend symbol
    • Accepted values: true| false
    • default: false
  • size
    • defines the size of the legend symbol of circle| square| triangle| diamond shapes - see “type”
    • Accepted values: Size as number (integer) in pixels
    • default: 11
  • lineWidth
    • defines the size of the legend symbol of line shape - see “type”
    • Accepted values: Size as number (integer) in pixels
    • default: 3
  • donutSize (only works in combination with circle shaped symbols)
    • defines a hole at the center of a circle
    • Accepted values: Size as number in pixels, or proportion of chart size / parent element (e.g. 5 or 0.3 * $w ). (For a full list of available chart constants, see list of chart constants.)
    • default: deactivated
  • donutColor (only works in combination with circle shaped symbols)
    • Fills the donut hole with a color when donutSize is defined. Leave it empty for a transparent donut hole.
    • Accepted values: color hex code (e.g. #87CEFA ), RGBA code (e.g rgba(135,205,250,1) ) or CSS color name (e.g. $LIGHTSKYBLUE )
    • default: deactivated

Example

<legendSymbol valueSetIndex="1">
   <style>beveled</style>
   <type>circle</type>
   <size>13</size>
</legendSymbol>

<legendSymbol valueSetIndex="2">
   <style>beveled</style>
   <type>square</type>
   <size>12</size>
</legendSymbol>

<legendSymbol valueSetIndex="3">
   <style>beveled</style>
   <type>line</type>
   <lineWidth>3</lineWidth>
</legendSymbol>

All elements not affected by Legend Symbol Option have been grayed out.