Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.GaugeSeries Class Reference

Creates a Gauge Chart. More...

Inheritance diagram for Ext.Net.GaugeSeries:
Ext.Net.Series Ext.Net.BaseItem Ext.Net.IAlias Ext.Net.IXObject Ext.Net.IBase

Classes

class  Builder
 
class  Config
 

Public Member Functions

 GaugeSeries ()
 The constructor More...
 
virtual void SetValue (object value)
 Sets the Gauge chart to the current specified value. More...
 
GaugeSeries.Builder ToBuilder ()
 
override IControlBuilder ToNativeBuilder ()
 
 GaugeSeries (Config config)
 
- Public Member Functions inherited from Ext.Net.Series
virtual void SetHidden (bool hidden)
 Hides or shows the Series More...
 
virtual void Hide ()
 Hides the Series. More...
 
virtual void Show ()
 Shows the Series. More...
 
virtual void SetTitle (string title)
 Sets the title More...
 
virtual void SetTitles (string[] titles)
 Sets the titles More...
 
- 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 ()
 
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 GaugeSeries (GaugeSeries.Config config)
 

Properties

override string InstanceOf [get]
 The JavaScript class name More...
 
virtual string Type [get]
 The alias More...
 
virtual ? int? Donut [get, set]
 Percentage of the radius of the donut hole compared to the entire disk. Defaults to 30. More...
 
virtual string AngleField [get, set]
 The store record field name to be used for the gauge value. The values bound to this field name must be positive real numbers. More...
 
virtual ? int? Maximum [get, set]
 The maximum value of the gauge. Defaults to 100. More...
 
virtual ? int? Minimum [get, set]
 The minimum value of the gauge. Defaults to 0. More...
 
virtual bool Needle [get, set]
 If true, display the gauge as a needle, otherwise as a sector. Defaults to false. More...
 
virtual ? int? NeedleLength [get, set]
 Percentage of the length of needle compared to the radius of the entire disk. Defaults to 90. More...
 
virtual ? int? NeedleWidth [get, set]
 Width of the needle in pixels. Defaults to 4. More...
 
virtual int[] Sectors [get, set]
 Allows to paint sectors of different colors in the background of the gauge. It is an array of numbers (each between minimum and maximum) that define the highest value of each sector. For N sectors, only (N-1) values are needed because it is assumed that the first sector starts at minimum and the last sector ends at maximum. it is superseded by SectorConfigs More...
 
GaugeSectorCollection SectorsConfig [get]
 Allows to paint sectors of different colors in the background of the gauge. It is an array of objects, each with the following properties: start : Number The starting value of the sector. If omitted, it uses the previous sector's end value or the chart's minimum. end : Number The ending value of the sector. If omitted, it uses the maximum defined for the chart. label : String The label for this sector. Labels are styled using the series' label config. color : String The color of the sector. If omitted, it uses one of the colors defined for the series or for the chart. style : Object An additional style object for the sector (for instance to set the opacity or to draw a line of a different color around the sector). More...
 
override bool ShowInLegend [get, set]
 Whether to add the gauge chart elements as legend items. Defaults to false. More...
 
virtual ? double? TotalAngle [get, set]
 The size of the sector that the series will occupy. More...
 
virtual ? int? TotalAngleDegrees [get, set]
 
virtual string TotalAngleDegreessProxy [get]
 
virtual ? int? Value [get, set]
 Directly sets the displayed value of the gauge. It is ignored if field is provided. More...
 
virtual bool WholeDisk [get, set]
 Indicates whether to show the whole disk or only the marked part. Defaults to false. More...
 
override ConfigOptionsCollection ConfigOptions [get]
 
- Properties inherited from Ext.Net.Series
override string InstanceOf [get]
 The JavaScript class name More...
 
DrawBackground Background [get, set]
 Sets the background of the surface the series is attached. More...
 
virtual string[] Colors [get, set]
 An array of color values which is used, in order of appearance, by the series. Each series can request one or more colors from the array. Radar, Scatter or Line charts require just one color each. Candlestick and OHLC require two (1 for drops + 1 for rises). Pie charts and Stacked charts (like Column or Pie charts) require one color for each data category they represent, so one color for each slice of a Pie chart or each segment of a Column chart. For a Gauge chart it is an array of color values which is used for the needle and the sectors. It overrides the colors that are provided by the current theme. More...
 
virtual bool Hidden [get, set]
 True to hide the series More...
 
virtual bool Highlight [get, set]
 If set to 'true', the default highlight style from highlightCfg will be used. Defaults to false. It is superseded by the HighlightConfig property. More...
 
virtual SpriteCollection HighlightConfig [get]
 The sprite attributes that will be applied to the highlighted items in the series. It will be merged with the highlightCfg. In case merging of 'highlight' and 'highlightCfg' configs in not the desired behavior, provide the 'highlightCfg' instead. It supersedes the Highlight property. More...
 
virtual SpriteCollection HighlightDefaults [get]
 The sprite attributes that will be applied to the highlighted items in the series. It will be merged with the highlightCfg. In case merging of 'highlight' and 'highlightCfg' configs in not the desired behavior, provide the 'highlightCfg' instead. More...
 
ChartLabel Label [get, set]
 The config of Series' Labels More...
 
virtual ? int? LabelOverflowPadding [get, set]
 Extra distance value for which the labelOverflow listener is triggered. More...
 
virtual SpriteCollection Marker [get]
 The sprite template used by marker instances on the series. More...
 
virtual SpriteCollection MarkerSubStyle [get]
 This is cyclic used if series have multiple marker sprites. More...
 
virtual JFunction Renderer [get]
 A function that can be provided to set custom styling properties to each rendered element. It receives (sprite, config, rendererData, index) as parameters. More...
 
virtual bool ShowInLegend [get, set]
 Whether to show this series in the legend. Defaults to true. More...
 
virtual bool ShowMarkers [get, set]
 Whether markers should be displayed at the data points along the line. If true, then the marker config item will determine the markers' styling. Defaults to true. More...
 
virtual SpriteCollection StyleSpec [get]
 Custom style configuration for the sprite used in the series. It overrides the style that is provided by the current theme. More...
 
virtual SpriteCollection SubStyle [get]
 This is the cyclic used if the series has multiple sprites. More...
 
virtual string Title [get, set]
 The human-readable name of the series (displayed in the legend). It is superseded by Titles. More...
 
virtual string[] Titles [get, set]
 The human-readable name of the series (displayed in the legend). It supersedes Title. More...
 
virtual ChartTip Tooltip [get, set]
 Add tooltips to the visualization's markers. The options for the tips are the same configuration used with Ext.tip.ToolTip. More...
 
virtual ? bool? UseDarkerStrokeColor [get, set]
 Colors for the series can be set directly through the 'colors' config, or indirectly with the current theme or the 'colors' config that is set onto the chart. These colors are used as "fill color". Set this config to true, if you want a darker color for the strokes. Set it to false if you want to use the same color as the fill color. It supersedes UseDarkerStrokeColorNumber. More...
 
virtual ? double? UseDarkerStrokeColorNumber [get, set]
 Colors for the series can be set directly through the 'colors' config, or indirectly with the current theme or the 'colors' config that is set onto the chart. These colors are used as "fill color". Set this config to true, if you want a darker color for the strokes. Set it to false if you want to use the same color as the fill color. It is superseded by UseDarkerStrokeColor. More...
 
virtual string StoreID [get, set]
 
virtual StoreCollection< StoreStore [get]
 The store to use for this series. If not specified, the series will use the chart's store. More...
 
SeriesListeners?? Listeners [get]
 Client-side JavaScript Event Handlers More...
 
string PropertyName [get]
 The IAlias' member More...
 
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]
 
- Properties inherited from Ext.Net.IAlias
string PropertyName [get]
 

Additional Inherited Members

- Protected Member Functions inherited from Ext.Net.Series
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

Creates a Gauge Chart.

Constructor & Destructor Documentation

◆ GaugeSeries() [1/2]

Ext.Net.GaugeSeries.GaugeSeries ( )
inline

The constructor

◆ GaugeSeries() [2/2]

Ext.Net.GaugeSeries.GaugeSeries ( Config  config)
inline

Member Function Documentation

◆ operator GaugeSeries()

static implicit Ext.Net.GaugeSeries.operator GaugeSeries ( GaugeSeries.Config  config)
inlinestatic

◆ SetValue()

virtual void Ext.Net.GaugeSeries.SetValue ( object  value)
inlinevirtual

Sets the Gauge chart to the current specified value.

Parameters
valueThe new value

◆ ToBuilder()

GaugeSeries.Builder Ext.Net.GaugeSeries.ToBuilder ( )
inline

◆ ToNativeBuilder()

override IControlBuilder Ext.Net.GaugeSeries.ToNativeBuilder ( )
inlinevirtual

Reimplemented from Ext.Net.BaseItem.

Property Documentation

◆ AngleField

virtual string Ext.Net.GaugeSeries.AngleField
getset

The store record field name to be used for the gauge value. The values bound to this field name must be positive real numbers.

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.GaugeSeries.ConfigOptions
get

◆ Donut

virtual ? int? Ext.Net.GaugeSeries.Donut
getset

Percentage of the radius of the donut hole compared to the entire disk. Defaults to 30.

◆ InstanceOf

override string Ext.Net.GaugeSeries.InstanceOf
get

The JavaScript class name

◆ Maximum

virtual ? int? Ext.Net.GaugeSeries.Maximum
getset

The maximum value of the gauge. Defaults to 100.

◆ Minimum

virtual ? int? Ext.Net.GaugeSeries.Minimum
getset

The minimum value of the gauge. Defaults to 0.

◆ Needle

virtual bool Ext.Net.GaugeSeries.Needle
getset

If true, display the gauge as a needle, otherwise as a sector. Defaults to false.

◆ NeedleLength

virtual ? int? Ext.Net.GaugeSeries.NeedleLength
getset

Percentage of the length of needle compared to the radius of the entire disk. Defaults to 90.

◆ NeedleWidth

virtual ? int? Ext.Net.GaugeSeries.NeedleWidth
getset

Width of the needle in pixels. Defaults to 4.

◆ Sectors

virtual int [] Ext.Net.GaugeSeries.Sectors
getset

Allows to paint sectors of different colors in the background of the gauge. It is an array of numbers (each between minimum and maximum) that define the highest value of each sector. For N sectors, only (N-1) values are needed because it is assumed that the first sector starts at minimum and the last sector ends at maximum. it is superseded by SectorConfigs

◆ SectorsConfig

GaugeSectorCollection Ext.Net.GaugeSeries.SectorsConfig
get

Allows to paint sectors of different colors in the background of the gauge. It is an array of objects, each with the following properties: start : Number The starting value of the sector. If omitted, it uses the previous sector's end value or the chart's minimum. end : Number The ending value of the sector. If omitted, it uses the maximum defined for the chart. label : String The label for this sector. Labels are styled using the series' label config. color : String The color of the sector. If omitted, it uses one of the colors defined for the series or for the chart. style : Object An additional style object for the sector (for instance to set the opacity or to draw a line of a different color around the sector).

It supersedes Sectors.

◆ ShowInLegend

override bool Ext.Net.GaugeSeries.ShowInLegend
getset

Whether to add the gauge chart elements as legend items. Defaults to false.

◆ TotalAngle

virtual ? double? Ext.Net.GaugeSeries.TotalAngle
getset

The size of the sector that the series will occupy.

◆ TotalAngleDegrees

virtual ? int? Ext.Net.GaugeSeries.TotalAngleDegrees
getset

◆ TotalAngleDegreessProxy

virtual string Ext.Net.GaugeSeries.TotalAngleDegreessProxy
getprotected

◆ Type

virtual string Ext.Net.GaugeSeries.Type
getprotected

The alias

◆ Value

virtual ? int? Ext.Net.GaugeSeries.Value
getset

Directly sets the displayed value of the gauge. It is ignored if field is provided.

◆ WholeDisk

virtual bool Ext.Net.GaugeSeries.WholeDisk
getset

Indicates whether to show the whole disk or only the marked part. Defaults to false.


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