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

Defines axis for charts. More...

Inheritance diagram for Ext.Net.Axis:
Ext.Net.BaseItem Ext.Net.IAlias Ext.Net.IXObject Ext.Net.IBase Ext.Net.Category3DAxis Ext.Net.CategoryAxis Ext.Net.Numeric3DAxis Ext.Net.NumericAxis Ext.Net.TimeAxis Ext.Net.Time3DAxis

Classes

class  Builder
 
class  Builder
 
class  Config
 

Public Member Functions

virtual void SetMinimum (double minimum)
 Updates the minimum of this axis. It doesn't redraw the Chart. Please call the Chart's Redraw manually if needed. More...
 
virtual void SetMaximum (double maximum)
 Updates the maximum of this axis. It doesn't redraw the Chart. Please call the Chart's Redraw manually if needed. More...
 
virtual void SetTitle (string title)
 Updates the title of this axis. It doesn't redraw the Chart. Please call the Chart's Redraw manually if needed. More...
 
virtual void SetLimits (Limits limits)
 
- 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 ()
 
virtual IControlBuilder ToNativeBuilder ()
 

Properties

override string InstanceOf [get]
 The JavaScript class name More...
 
virtual bool AdjustByMajorUnit [get, set]
 Whether to make the auto-calculated minimum and maximum of the axis a multiple of the interval between the major ticks of the axis. If majorTickSteps, minimum or maximum configs have been set, this config will be ignored. Defaults to 'true'. More...
 
DrawBackground Background [get, set]
 The background config for the axis surface. More...
 
virtual AbstractChart Chart [get]
 The owner Chart More...
 
virtual string[] Fields [get, set]
 An array containing the names of the record fields which should be mapped along the axis. This is optional if the binding between series and fields is clear. More...
 
virtual ? int? Floating [get, set]
 If floating is a number, then it's a percentage displacement of the axis from its initial position in the direction opposite to the axis' direction. For instance, '{position:"left", floating:75}' displays a vertical axis at 3/4 of the chart, starting from the left. It is equivalent to '{position:"right", floating:25}'. The FloatingConfig property supersede the Floating one. More...
 
AxisFloating FloatingConfig [get, set]
 If floating is an object, then floating.value is the position of this axis along another axis, defined by floating.alongAxis, where alongAxis is an ID, an Ext.chart.AbstractChart.axes config index, or the other axis itself. alongAxis must have an opposite alignment. The FloatingConfig property supersede the Floating one. More...
 
virtual bool Grid [get, set]
 True to enable the grid. Defaults to false More...
 
AxisGrid GridConfig [get, set]
 The grid configuration object for the Axis style. Can contain stroke or fill attributes. Also may contain an odd or even property in which you only style things on odd or even rows. More...
 
virtual bool Hidden [get, set]
 Indicate whether to hide the axis. If the axis is hidden, one of the axis line, ticks, labels or the title will be shown and no margin will be taken. The coordination mechanism works fine no matter if the axis is hidden. Defaults to false. More...
 
virtual string AxisID [get, set]
 The axis id More...
 
ChartLabel Label [get, set]
 The config for chart label. More...
 
virtual string Layout [get, set]
 The axis layout config. See Ext.chart.axis.layout.Layout. More...
 
Limits Limits [get, set]
 The limit lines configuration for the axis. More...
 
virtual string LinkedToID [get, set]
 Axis (itself, its ID or index) that this axis is linked to. When an axis is linked to a master axis, it will use the same data as the master axis. It can be used to show additional info, or to ease reading the chart by duplicating the scales. It supersedes the LinkedToIndex and LinkedToRef properties. More...
 
virtual ? int? LinkedToIndex [get, set]
 Axis (itself, its ID or index) that this axis is linked to. When an axis is linked to a master axis, it will use the same data as the master axis. It can be used to show additional info, or to ease reading the chart by duplicating the scales. It supersedes the LinkedToRef and is superseded by the LinkedToID property. More...
 
virtual string LinkedToRef [get, set]
 Axis (itself, its ID or index) that this axis is linked to. When an axis is linked to a master axis, it will use the same data as the master axis. It can be used to show additional info, or to ease reading the chart by duplicating the scales. It is superseded by the LinkedToID and LinkedToIndex properties. More...
 
virtual string LinkedToProxy [get]
 The proxy to render the linkedTo config option More...
 
virtual ? int? MajorTickSteps [get, set]
 Forces the number of major ticks to the specified value. Defaults to 0. More...
 
virtual int Margin [get, set]
 The margin of the axis. Used to control the spacing between axes in charts with multiple axes. Unlike CSS where the margin is added on all 4 sides of an element, the margin is the total space that is added horizontally for a vertical axis, vertically for a horizontal axis, and radially for an angular axis. Defaults to 0. More...
 
virtual ? double? MaxZoom [get, set]
 The maximum zooming level for axis. Defaults to 10000. More...
 
virtual ? double? Maximum [get, set]
 The maximum value drawn by the axis. If not set explicitly, the axis maximum will be calculated automatically. More...
 
virtual ? double? MinZoom [get, set]
 The minimum zooming level for axis. Defaults to 1. More...
 
virtual ? double? Minimum [get, set]
 The minimum value drawn by the axis. If not set explicitly, the axis minimum will be calculated automatically. More...
 
virtual ? int? MinorTickSteps [get, set]
 The number of small ticks between two major ticks. Defaults to 0. More...
 
virtual bool NeedHighPrecision [get, set]
 Indicates that the axis needs high precision surface implementation. See Ext.draw.engine.Canvas.highPrecision. Defaults to false. More...
 
virtual Position Position [get, set]
 Where to set the axis. Available options are left, bottom, right, top, radial and angular. More...
 
virtual string PositionProxy [get]
 
string PropertyName [get]
 The member of IAlias More...
 
virtual bool ReconcileRange [get, set]
 If 'true' the range of the axis will be a union of ranges of all the axes with the same direction. Defaults to 'false'. More...
 
virtual JFunction Renderer [get]
 Allows to change the text shown next to the tick. More...
 
virtual string Segmenter [get, set]
 The segmenter config. See Ext.chart.axis.segmenter.Segmenter. More...
 
AxisSprite Style [get, set]
 The style for the axis line and ticks. Refer to the Ext.chart.axis.sprite.Axis. More...
 
virtual string Title [get, set]
 The "text" of the title sprite. More...
 
Sprite TitleConfig [get, set]
 The title style. More...
 
virtual int TitleMargin [get, set]
 The margin around the axis title. Unlike CSS where the margin is added on all 4 sides of an element, the titleMargin is the total space that is added horizontally for a vertical title and vertically for an horizontal title, with half the titleMargin being added on either side. Defaults to 4. More...
 
virtual double[] VisibleRange [get, set]
 Specify the proportion of the axis to be rendered. The series bound to this axis will be synchronized and transformed. Defaults to [0, 1]. More...
 
AxisListeners?? Listeners [get]
 Client-side JavaScript Event Handlers 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.BaseItem
 BaseItem (Control owner)
 
 BaseItem ()
 
virtual void OwnerUpdate (Control owner)
 
virtual void OnDataBinding (EventArgs e)
 

Detailed Description

Defines axis for charts.

Member Function Documentation

◆ SetLimits()

virtual void Ext.Net.Axis.SetLimits ( Limits  limits)
inlinevirtual

◆ SetMaximum()

virtual void Ext.Net.Axis.SetMaximum ( double  maximum)
inlinevirtual

Updates the maximum of this axis. It doesn't redraw the Chart. Please call the Chart's Redraw manually if needed.

Parameters
maximumThe new maximum

◆ SetMinimum()

virtual void Ext.Net.Axis.SetMinimum ( double  minimum)
inlinevirtual

Updates the minimum of this axis. It doesn't redraw the Chart. Please call the Chart's Redraw manually if needed.

Parameters
minimumThe new minimum

◆ SetTitle()

virtual void Ext.Net.Axis.SetTitle ( string  title)
inlinevirtual

Updates the title of this axis. It doesn't redraw the Chart. Please call the Chart's Redraw manually if needed.

Parameters
titleThe new title

Property Documentation

◆ AdjustByMajorUnit

virtual bool Ext.Net.Axis.AdjustByMajorUnit
getset

Whether to make the auto-calculated minimum and maximum of the axis a multiple of the interval between the major ticks of the axis. If majorTickSteps, minimum or maximum configs have been set, this config will be ignored. Defaults to 'true'.

◆ AxisID

virtual string Ext.Net.Axis.AxisID
getset

The axis id

◆ Background

DrawBackground Ext.Net.Axis.Background
getset

The background config for the axis surface.

◆ Chart

virtual AbstractChart Ext.Net.Axis.Chart
get

The owner Chart

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.Axis.ConfigOptions
get

◆ Fields

virtual string [] Ext.Net.Axis.Fields
getset

An array containing the names of the record fields which should be mapped along the axis. This is optional if the binding between series and fields is clear.

◆ Floating

virtual ? int? Ext.Net.Axis.Floating
getset

If floating is a number, then it's a percentage displacement of the axis from its initial position in the direction opposite to the axis' direction. For instance, '{position:"left", floating:75}' displays a vertical axis at 3/4 of the chart, starting from the left. It is equivalent to '{position:"right", floating:25}'. The FloatingConfig property supersede the Floating one.

◆ FloatingConfig

AxisFloating Ext.Net.Axis.FloatingConfig
getset

If floating is an object, then floating.value is the position of this axis along another axis, defined by floating.alongAxis, where alongAxis is an ID, an Ext.chart.AbstractChart.axes config index, or the other axis itself. alongAxis must have an opposite alignment. The FloatingConfig property supersede the Floating one.

◆ Grid

virtual bool Ext.Net.Axis.Grid
getset

True to enable the grid. Defaults to false

◆ GridConfig

AxisGrid Ext.Net.Axis.GridConfig
getset

The grid configuration object for the Axis style. Can contain stroke or fill attributes. Also may contain an odd or even property in which you only style things on odd or even rows.

◆ Hidden

virtual bool Ext.Net.Axis.Hidden
getset

Indicate whether to hide the axis. If the axis is hidden, one of the axis line, ticks, labels or the title will be shown and no margin will be taken. The coordination mechanism works fine no matter if the axis is hidden. Defaults to false.

◆ InstanceOf

override string Ext.Net.Axis.InstanceOf
get

The JavaScript class name

◆ Label

ChartLabel Ext.Net.Axis.Label
getset

The config for chart label.

◆ Layout

virtual string Ext.Net.Axis.Layout
getset

The axis layout config. See Ext.chart.axis.layout.Layout.

◆ Limits

Limits Ext.Net.Axis.Limits
getset

The limit lines configuration for the axis.

◆ LinkedToID

virtual string Ext.Net.Axis.LinkedToID
getset

Axis (itself, its ID or index) that this axis is linked to. When an axis is linked to a master axis, it will use the same data as the master axis. It can be used to show additional info, or to ease reading the chart by duplicating the scales. It supersedes the LinkedToIndex and LinkedToRef properties.

◆ LinkedToIndex

virtual ? int? Ext.Net.Axis.LinkedToIndex
getset

Axis (itself, its ID or index) that this axis is linked to. When an axis is linked to a master axis, it will use the same data as the master axis. It can be used to show additional info, or to ease reading the chart by duplicating the scales. It supersedes the LinkedToRef and is superseded by the LinkedToID property.

◆ LinkedToProxy

virtual string Ext.Net.Axis.LinkedToProxy
getprotected

The proxy to render the linkedTo config option

◆ LinkedToRef

virtual string Ext.Net.Axis.LinkedToRef
getset

Axis (itself, its ID or index) that this axis is linked to. When an axis is linked to a master axis, it will use the same data as the master axis. It can be used to show additional info, or to ease reading the chart by duplicating the scales. It is superseded by the LinkedToID and LinkedToIndex properties.

◆ Listeners

AxisListeners?? Ext.Net.Axis.Listeners
get

Client-side JavaScript Event Handlers

◆ MajorTickSteps

virtual ? int? Ext.Net.Axis.MajorTickSteps
getset

Forces the number of major ticks to the specified value. Defaults to 0.

◆ Margin

virtual int Ext.Net.Axis.Margin
getset

The margin of the axis. Used to control the spacing between axes in charts with multiple axes. Unlike CSS where the margin is added on all 4 sides of an element, the margin is the total space that is added horizontally for a vertical axis, vertically for a horizontal axis, and radially for an angular axis. Defaults to 0.

◆ Maximum

virtual ? double? Ext.Net.Axis.Maximum
getset

The maximum value drawn by the axis. If not set explicitly, the axis maximum will be calculated automatically.

◆ MaxZoom

virtual ? double? Ext.Net.Axis.MaxZoom
getset

The maximum zooming level for axis. Defaults to 10000.

◆ Minimum

virtual ? double? Ext.Net.Axis.Minimum
getset

The minimum value drawn by the axis. If not set explicitly, the axis minimum will be calculated automatically.

◆ MinorTickSteps

virtual ? int? Ext.Net.Axis.MinorTickSteps
getset

The number of small ticks between two major ticks. Defaults to 0.

◆ MinZoom

virtual ? double? Ext.Net.Axis.MinZoom
getset

The minimum zooming level for axis. Defaults to 1.

◆ NeedHighPrecision

virtual bool Ext.Net.Axis.NeedHighPrecision
getset

Indicates that the axis needs high precision surface implementation. See Ext.draw.engine.Canvas.highPrecision. Defaults to false.

◆ Position

virtual Position Ext.Net.Axis.Position
getset

Where to set the axis. Available options are left, bottom, right, top, radial and angular.

◆ PositionProxy

virtual string Ext.Net.Axis.PositionProxy
getprotected

◆ PropertyName

string Ext.Net.Axis.PropertyName
get

The member of IAlias

◆ ReconcileRange

virtual bool Ext.Net.Axis.ReconcileRange
getset

If 'true' the range of the axis will be a union of ranges of all the axes with the same direction. Defaults to 'false'.

◆ Renderer

virtual JFunction Ext.Net.Axis.Renderer
get

Allows to change the text shown next to the tick.

The renderer function is called with the following parameters:

- axis : Ext.chart.axis.Axis
    The axis
- label : String|Number
    The label
- layoutContext : Object
    The object that holds calculated positions of axis' ticks based on current layout, segmenter, axis length and configuration.
- lastLabel : String|Number|null
    The last label (if any)

Returns: String The label to display

◆ Segmenter

virtual string Ext.Net.Axis.Segmenter
getset

The segmenter config. See Ext.chart.axis.segmenter.Segmenter.

◆ Style

AxisSprite Ext.Net.Axis.Style
getset

The style for the axis line and ticks. Refer to the Ext.chart.axis.sprite.Axis.

◆ Title

virtual string Ext.Net.Axis.Title
getset

The "text" of the title sprite.

◆ TitleConfig

Sprite Ext.Net.Axis.TitleConfig
getset

The title style.

◆ TitleMargin

virtual int Ext.Net.Axis.TitleMargin
getset

The margin around the axis title. Unlike CSS where the margin is added on all 4 sides of an element, the titleMargin is the total space that is added horizontally for a vertical title and vertically for an horizontal title, with half the titleMargin being added on either side. Defaults to 4.

◆ VisibleRange

virtual double [] Ext.Net.Axis.VisibleRange
getset

Specify the proportion of the axis to be rendered. The series bound to this axis will be synchronized and transformed. Defaults to [0, 1].


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