Ext.Net.ChartLabel Class Reference

Sprite used to represent labels in series. More...

Inheritance diagram for Ext.Net.ChartLabel:

Classes
class	Builder
class	Builder
class	Config

Public Member Functions
	ChartLabel ()
	The constructor More...
ChartLabel.Builder	ToBuilder ()
override IControlBuilder	ToNativeBuilder ()
	ChartLabel (Config config)
Public Member Functions inherited from Ext.Net.TextSprite
	TextSprite ()
TextSprite.Builder	ToBuilder ()
override IControlBuilder	ToNativeBuilder ()
	TextSprite (Config config)
Public Member Functions inherited from Ext.Net.AbstractSprite
virtual void	Destroy ()
	Removes the sprite and clears all listeners. More...
virtual void	Hide ()
	Hides the sprite. More...
virtual void	Show ()
	Show the sprite. More...
virtual void	SetAttributes (Dictionary< string, object > attrs, bool bypassNormalization)
	Change the attributes of the sprite. More...
virtual void	SetAttributes (Dictionary< string, object > attrs)
	Change the attributes of the sprite. More...
virtual void	SetAttributes (AbstractSprite attrs, bool bypassNormalization)
	Change the attributes of the sprite. More...
virtual void	SetAttributes (AbstractSprite attrs)
	Change the attributes of the sprite. More...
virtual string	Serialize ()
Public Member Functions inherited from Ext.Net.BaseItem
virtual bool	HasExplicitValue (string name)
void	EnsureDataBind ()
virtual void	Call (string name)
virtual void	Call (string name, params object[] args)
virtual void	AddScript (string script)
virtual void	AddScript (string script, params object[] args)
virtual bool	IsEmptyObject ()
T	Apply< T > (IApply config)
BaseItem	Apply (object config)
virtual void	LoadViewState (object state)
virtual object	SaveViewState ()
virtual void	TrackViewState ()
void	SetDirty ()
virtual void	DataBind ()

Static Public Member Functions
static implicit	operator ChartLabel (ChartLabel.Config config)
Static Public Member Functions inherited from Ext.Net.TextSprite
static implicit	operator TextSprite (TextSprite.Config config)

Properties
virtual bool	CalloutLine [get, set]
	True to draw a line between the label and the chart with the default settings. Defaults to true. More...
ChartCalloutLine	CalloutLineConfig [get, set]
	The setting of the line to draw between the label and the chart. You can define the 'color', 'width' and 'length' properties of the line. This config is only applicable when the label is displayed outside the chart. More...
virtual SeriesLabelDisplay	Display [get, set]
	Specifies the presence and position of the labels. The possible values depend on the chart type. For Line charts: 'under' | 'over' | 'rotate'. For Bar charts: 'insideStart' | 'insideEnd' | 'outside'. For Pie charts: 'outside' | 'rotate'. For all charts: 'none' hides the labels. Default value: 'none'. More...
virtual string	Color [get, set]
	The color of the label text. Default value: '#000' (black). More...
virtual string[]	Field [get, set]
	The name(s) of the field(s) to be displayed in the labels. If your chart has 3 series that correspond to the fields 'a', 'b', and 'c' of your model and you only want to display labels for the series 'c', you must still provide an array [null, null, 'c']. More...
virtual Orientation	Orientation [get, set]
	Either 'horizontal' or 'vertical'. If not set (default), the orientation is inferred from the value of the flipXY property of the series. More...
virtual string	OrientationProxy [get]
virtual JFunction	Renderer [get]
	Optional function for formatting the label into a displayable value. More...
override ConfigOptionsCollection	ConfigOptions [get]
Properties inherited from Ext.Net.TextSprite
override string	Type [get]
virtual string	Font [get, set]
	The font displayed. Defaults to: '10px sans-serif' More...
virtual string	FontFamily [get, set]
	The family of the font displayed. Defaults to: 'sans-serif' More...
virtual string	FontSize [get, set]
	The size of the font displayed. Defaults to: '10px' More...
virtual string	FontStyle [get, set]
	The style of the font displayed. {normal, italic, oblique} Defaults to: '' More...
virtual string	FontVariant [get, set]
	The variant of the font displayed. {normal, small-caps} Defaults to: '' More...
virtual string	FontWeight [get, set]
	The weight of the font displayed. {normal, bold, bolder, lighter} Defaults to: '' More...
virtual string	Text [get, set]
	The text represented in the sprite. Defaults to: '' More...
virtual TextSpriteAlign	TextAlign [get, set]
	The alignment of the text displayed. {left, right, center, start, end} Defaults to: 'start' More...
virtual DominantBaseline	TextBaseline [get, set]
virtual ? int?	X [get, set]
virtual ? int?	Y [get, set]
override ConfigOptionsCollection	ConfigOptions [get]
Properties inherited from Ext.Net.AbstractSprite
virtual string	Type [get]
virtual DrawContainer	Draw [get, set]
virtual string	SpriteID [get, set]
virtual ? int?	Height [get, set]
	The height of the sprite. Defaults to: 1 More...
virtual ? int?	Width [get, set]
	The width of the sprite. Defaults to: 1 More...
virtual ? int?	X [get, set]
	The position of the sprite on the x-axis. Defaults to: 0 More...
virtual ? int?	Y [get, set]
	The position of the sprite on the y-axis. Defaults to: 0 More...
virtual int[]	LineDash [get, set]
	array of non-negative numbers specifying a dash/space sequence. More...
virtual ? int?	LineDashOffset [get, set]
	A number specifying how far into the line dash sequence drawing commences. More...
virtual ? double?	FillOpacity [get, set]
	The opacity of the fill. Limited from 0 to 1. Defaults to: 1 More...
virtual string	FillStyle [get, set]
	The color of the shape (a CSS color value). Defaults to: "none" More...
virtual ? double?	GlobalAlpha [get, set]
	The opacity of the sprite. Limited from 0 to 1. Defaults to: 1 More...
virtual ? double?	Opacity [get, set]
	The opacity of the sprite. Limited from 0 to 1. Defaults to: 1 More...
virtual string	GlobalCompositeOperation [get, set]
	Indicates how source images are drawn onto a destination image. globalCompositeOperation attribute is not supported by the SVG and VML (excanvas) engines. Defaults to: source-over More...
virtual ? bool?	Hidden [get, set]
	Determines whether or not the sprite is hidden. Defaults to: false More...
virtual StrokeLinecap	LineCap [get, set]
	The style of the line caps. Defaults to: "butt" More...
virtual StrokeLinejoin	Linejoin [get, set]
	The style of the line join. Defaults to: "miter" More...
virtual ? double?	LineWidth [get, set]
	The width of the line stroke. Defaults to: 1 More...
virtual ? int?	MiterLimit [get, set]
	Sets the distance between the inner corner and the outer corner where two lines meet. Defaults to: 10 More...
virtual ? int?	RotationCenterX [get, set]
	The central coordinate of the sprite's scale operation on the x-axis. Defaults to: null More...
virtual ? int?	RotationCenterY [get, set]
	The central coordinate of the sprite's scale operation on the y-axis. Defaults to: null More...
virtual ? double?	RotationRads [get, set]
	The radians of rotation of the sprite. Defaults to 0. More...
virtual ? int?	RotationDegrees [get, set]
virtual string	RotationDegreesProxy [get]
virtual ? int?	ScalingCenterX [get, set]
	The central coordinate of the sprite's scale operation on the x-axis. Defaults to: null More...
virtual ? int?	ScalingCenterY [get, set]
	The central coordinate of the sprite's scale operation on the y-axis. Defaults to: null More...
virtual ? double?	Scaling [get, set]
	The scaling of the sprite on the xy-axis. Defaults to: 1 More...
virtual ? double?	ScalingX [get, set]
	The scaling of the sprite on the x-axis. Defaults to: 1 More...
virtual ? double?	ScalingY [get, set]
	The scaling of the sprite on the y-axis. Defaults to: 1 More...
virtual ? int?	ShadowBlur [get, set]
	The amount blur used on the shadow. Defaults to: 0 More...
virtual string	ShadowColor [get, set]
	The amount blur used on the shadow. Defaults to: 0 More...
virtual ? int?	ShadowOffsetX [get, set]
	The offset of the sprite's shadow on the x-axis. Defaults to: 0 More...
virtual ? int?	ShadowOffsetY [get, set]
	The offset of the sprite's shadow on the y-axis. Defaults to: 0 More...
virtual ? double?	StrokeOpacity [get, set]
	The opacity of the stroke. Limited from 0 to 1. Defaults to: 1 More...
virtual string	StrokeStyle [get, set]
	The color of the stroke (a CSS color value). Defaults to: "none" More...
virtual bool	TransformFillStroke [get, set]
	Determines whether the fill and stroke are affected by sprite transformations. Defaults to: false More...
virtual ? double?	TranslationX [get, set]
	The translation of the sprite on the x-axis. Defaults to: 0 More...
virtual ? double?	TranslationY [get, set]
	The translation of the sprite on the y-axis. Defaults to: 0 More...
virtual ? int?	ZIndex [get, set]
	The stacking order of the sprite. Defaults to: 0 More...
virtual string	Proxy [get]
virtual ? int?	Duration [get, set]
	Time in milliseconds for the animation to last. More...
virtual Easing	Easing [get, set]
	This describes how the intermediate values used during a transition will be calculated. It allows for a transition to change speed over its duration. Note that cubic-bezier will create a custom easing curve following the CSS3 transition-timing-function specification http://www.w3.org/TR/css3-transitions/-transition-timing-function_tag. The four values specify points P1 and P2 of the curve as (x1, y1, x2, y2). All values must be in the range [0, 1] or the definition is invalid More...
virtual string	EasingArgs [get, set]
virtual string	EasingProxy [get]
override ConfigOptionsCollection	ConfigOptions [get]
Properties inherited from Ext.Net.BaseItem
virtual string	InstanceOf [get]
ItemState	State [get]
virtual DefaultValueMode	DefaultValueMode [get, set]
virtual bool	DesignMode [get]
bool	AutoDataBind [get, set]
ResourceManager	ResourceManager [get]
virtual Control	Owner [get, set]
	The Owner Control for this Listener. More...
virtual bool	IsDefault [get]
	Does this object currently represent it's default state. More...
bool	IsTrackingViewState [get]
EventHandlerList	Events [get]
EventHandler	DataBinding
Control??	BindingContainer [get]
virtual ConfigItemCollection??	CustomConfig [get]
	Collection of custom js config More...
virtual ConfigOptionsCollection	ConfigOptions [get]
virtual ConfigOptionsExtraction	ConfigOptionsExtraction [get]
System.Web.Mvc.HtmlHelper??	HtmlHelper [get, set]
Properties inherited from Ext.Net.IXObject
ConfigOptionsCollection	ConfigOptions [get]
ConfigOptionsExtraction	ConfigOptionsExtraction [get]
DefaultValueMode	DefaultValueMode [get, set]

Additional Inherited Members
Protected Member Functions inherited from Ext.Net.AbstractSprite
virtual void	CallTemplate (string name, params object[] args)
Protected Member Functions inherited from Ext.Net.BaseItem
	BaseItem (Control owner)
	BaseItem ()
virtual void	OwnerUpdate (Control owner)
virtual void	OnDataBinding (EventArgs e)

Detailed Description

Sprite used to represent labels in series.

Constructor & Destructor Documentation

ChartLabel() [1/2]

Ext.Net.ChartLabel.ChartLabel ( )

inline

The constructor

ChartLabel() [2/2]

Ext.Net.ChartLabel.ChartLabel ( Config  config )

inline

Member Function Documentation

operator ChartLabel()

static implicit Ext.Net.ChartLabel.operator ChartLabel ( ChartLabel.Config  config )

inlinestatic

ToBuilder()

ChartLabel.Builder Ext.Net.ChartLabel.ToBuilder ( )

inline

ToNativeBuilder()

override IControlBuilder Ext.Net.ChartLabel.ToNativeBuilder ( )

inlinevirtual

Reimplemented from Ext.Net.BaseItem.

Property Documentation

CalloutLine

virtual bool Ext.Net.ChartLabel.CalloutLine

getset

True to draw a line between the label and the chart with the default settings. Defaults to true.

CalloutLineConfig

ChartCalloutLine Ext.Net.ChartLabel.CalloutLineConfig

getset

The setting of the line to draw between the label and the chart. You can define the 'color', 'width' and 'length' properties of the line. This config is only applicable when the label is displayed outside the chart.

Color

virtual string Ext.Net.ChartLabel.Color

getset

The color of the label text. Default value: '#000' (black).

ConfigOptions

override ConfigOptionsCollection Ext.Net.ChartLabel.ConfigOptions

get

Display

virtual SeriesLabelDisplay Ext.Net.ChartLabel.Display

getset

Specifies the presence and position of the labels. The possible values depend on the chart type. For Line charts: 'under' | 'over' | 'rotate'. For Bar charts: 'insideStart' | 'insideEnd' | 'outside'. For Pie charts: 'outside' | 'rotate'. For all charts: 'none' hides the labels. Default value: 'none'.

Field

virtual string [] Ext.Net.ChartLabel.Field

getset

The name(s) of the field(s) to be displayed in the labels. If your chart has 3 series that correspond to the fields 'a', 'b', and 'c' of your model and you only want to display labels for the series 'c', you must still provide an array [null, null, 'c'].

Orientation

virtual Orientation Ext.Net.ChartLabel.Orientation

getset

Either 'horizontal' or 'vertical'. If not set (default), the orientation is inferred from the value of the flipXY property of the series.

OrientationProxy

virtual string Ext.Net.ChartLabel.OrientationProxy

getprotected

Renderer

virtual JFunction Ext.Net.ChartLabel.Renderer

get

Optional function for formatting the label into a displayable value.

The arguments are:

Parameters: text : String The label's text. sprite : Object The sprite affected by the renderer. The visual attributes are in sprite.attr. The data field is available in sprite.getField(). config : Object The sprite configuration. It varies with the series and the type of sprite: for instance, a Line chart sprite might have just the x and y properties while a Bar chart sprite also has width and height. A type might be present too. For instance to draw each marker and each segment of a Line chart, the renderer is called with the config.type set to either marker or line. rendererData : Object A record with different properties depending on the type of chart. The only guaranteed property is rendererData.store, the store used by the series. In some cases, a store may not exist: for instance a Gauge chart may read its value directly from its configuration; in this case rendererData.store is null and the value is available in rendererData.value. index : Number The index of the sprite. It is usually the index of the store record associated with the sprite, in which case the record can be obtained with store.getData().items[index]. If the chart is not associated with a store, the index represents the index of the sprite within the series. For instance a Gauge chart may have as many sprites as there are sectors in the background of the gauge, plus one for the needle.

Returns : Object|String The attributes that have been changed or added, or the text for the label.

Example to enclose every other label in parentheses: renderer: function (text) { if (index % 2 == 0) { return '(' + text + ')' } }

---

The documentation for this class was generated from the following files:

• ChartLabel.cs
• ChartLabelConfigOptions.cs
• ChartLabelBuilder.cs
• ChartLabelConfig.cs