Overview  
ConfigsEventsMethods
Legend  

the legend componment

Configs
ParameterTypeDescriptionDefined By
StringSpecifies the horizontal position of the legend in chart.(defaults to 'right').Available value are:
@Option 'left'
@Option 'center' Only applies when valign = 'top|bottom'
@Option 'right'
Legend
StringSpecifies the backgroundColor for this element.(defaults to 'FDFDFD')
Painter
ObjectHere,specify as true by default
Painter
StringSpecifies the font's color for this element.(defaults to 'black')
Painter
floatSpecifies the factor make color dark or light for this element,relative to background-color,the bigger the value you set,the larger the color changed.scope{0.01 - 0.5}.(defaults to '0.15')
Painter
Number/StringSpecifies the number of column.(default to 1) Note:If set to 'max',the list will be lie on the property row
Legend
ArrayRequired,The datasource of Legend.Normally,this will given by chart.(default to undefined)
Legend
StringSpecifies the font of this element.(default to 'Verdana')
Component
NumberSpecifies the font size of this element in pixels.(default to 12)
Component
StringSpecifies the unit of font-size.(default to 'px')
Component
StringSpecifies the font weight of this element.(default to 'normal')
Component
BooleanTrue to apply the gradient.(default to false)
Painter
StringSpecifies the gradient mode of background.(defaults to 'LinearGradientUpDown')
@Option 'LinearGradientUpDown'
@Option 'LinearGradientDownUp'
@Option 'LinearGradientLeftRight'
@Option 'LinearGradientRightLeft'
@Option 'RadialGradientOutIn'
@Option 'RadialGradientInOut'
Painter
NumberSpecifies the space between the sign and text.(default to 5)
Legend
NumberSpecifies the lineheight when text display multiline.(default to 16)
Legend
ObjectA config object containing one or more event handlers.(default to null)
Painter
NumberSpecifies the limited width.Normally,this will given by chart.(default to 0)
Legend
NumberSpecifies Horizontal offset(x-axis) in pixel.(default to 0)
Painter
NumberSpecifies Vertical distance (y-axis) in pixel.(default to 0)
Painter
NumberIf you want to totally override the positioning of the chart,you should setting it.(default to null)
Painter
NumberIf you want to totally override the positioning of the chart,you should setting it.(default to null)
Painter
NumberSpecifies the padding for this element in pixel,the same rule as css padding.(defaults to 10)
Painter
Number/StringSpecifies the number of column.(default to 'max') Note:If set to 'max',the list will be lie on the property column
Legend
BooleanSpecifies whether the element should be show a shadow.In general there will be get a high render speed when apply false.(default to false)
Element
NumberSpecifies How blur you want your shadow to be.(default to 4)
Element
StringSpecifies the color of your shadow is.(default to '#666666')
Element
NumberSpecifies Horizontal distance (x-axis) between the shadow and the shape in pixel.(default to 0)
Element
NumberSpecifies Vertical distance (y-axis) between the shadow and the shape in pixel.(default to 0)
Element
StringSpecifies the shape of legend' sign (default to 'square') Available value are:
@Option 'round'
@Option 'square'
@Option 'bar'
@Option 'round-bar'
@Option 'square-bar'
Legend
Numberthe size of legend' sign (default to 10)
Legend
Numberthe distance of legend' sign and text (default to 5)
Legend
StringSpecifies the default strokeStyle of the canvas's context in this element.(defaults to 'gray')
Painter
BooleanIf true the text's color will accord with sign's.(default to false)
Legend
Stringthis property specifies the vertical position of the legend in an module (defaults to 'middle'). Available value are:
@Option 'top'
@Option 'middle' Only applies when align = 'left|right'
@Option 'bottom'
Legend
NumberSpecifies the z-index.(default to 0)
Painter
Events
NameDescriptionDefined By
beforedraw
Fires before the element drawing.Return false from an event handler to stop the draw.
Parameter
  • this : Legend  
Painter
click
Fires when this element is clicked
Parameter
  • this : Legend  
  • e : EventObject   The click event object
  • param : Object   The additional parameter
Painter
draw
Fires after the element drawing when calling the draw method.
Parameter
  • this : Legend  
Painter
initialize
Fires after the element initializing is finished this is for test
Parameter
  • this : Legend  
Element
mousemove
Fires when the mouse move on the element
Parameter
  • this : Legend  
  • e : EventObject   The mousemove event object
Painter
mouseout
Fires when the mouse exits the element
Parameter
  • this : Legend  
  • e : EventObject   The mouseout event object
Painter
mouseover
Fires when the mouse hovers over the element
Parameter
  • this : Legend  
  • e : EventObject   The mouseover event object
Painter
parse
Fires when parse this element'data.Return text value will override existing.
Parameter
  • this : Legend  
  • text : string   the text will display
  • i : int   the index of data
Legend
Methods
NameDescriptionDefined By
draw
The commnd fire to draw the chart use configuration,
* this is a abstract method.Currently known,both iChart.Chart and iChart.Component implement this method.
Parameter
  • None
Return
  void
Painter
getDimension
return the component's dimension,return hold following property
* @property x:the left-top coordinate-x
* @property y:the left-top coordinate-y
* @property width:the width of component,note:available there applies box model
* @property height:the height of component,note:available there applies box model
Parameter
  • None
Return
  object
Component
reference:Component