Class ChartAxisBuilder
Inheritance
System.Object
ChartAxisBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChartAxisBuilder : ControlBuilder
Constructors
ChartAxisBuilder()
Declaration
public ChartAxisBuilder()
ChartAxisBuilder(ChartAxis)
Declaration
public ChartAxisBuilder(ChartAxis model)
Parameters
ChartAxisBuilder(List<ChartAxis>)
Declaration
public ChartAxisBuilder(List<ChartAxis> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<ChartAxis> |
collection |
|
Methods
Add()
Declaration
Border(ChartLabelBorder)
Border of the multi level labels.
Declaration
public ChartAxisBuilder Border(ChartLabelBorder border)
Parameters
Returns
Border(Action<ChartLabelBorderBuilder>)
Declaration
public ChartAxisBuilder Border(Action<ChartLabelBorderBuilder> border)
Parameters
Returns
Coefficient(Double)
The polar radar radius position.
Declaration
public ChartAxisBuilder Coefficient(double coefficient)
Parameters
| Type |
Name |
Description |
| System.Double |
coefficient |
|
Returns
ColumnIndex(Double)
Specifies the index of the column where the axis is associated,
when the chart area is divided into multiple plot areas by using columns.
Declaration
public ChartAxisBuilder ColumnIndex(double columnIndex)
Parameters
| Type |
Name |
Description |
| System.Double |
columnIndex |
|
Returns
CrossesAt(Object)
Specifies the value at which the axis line has to be intersect with the vertical axis or vice versa.
Declaration
public ChartAxisBuilder CrossesAt(object crossesAt)
Parameters
| Type |
Name |
Description |
| System.Object |
crossesAt |
|
Returns
CrossesInAxis(String)
Specifies axis name with which the axis line has to be crossed.
Declaration
public ChartAxisBuilder CrossesInAxis(string crossesInAxis)
Parameters
| Type |
Name |
Description |
| System.String |
crossesInAxis |
|
Returns
Options to customize the crosshair ToolTip.
Declaration
public ChartAxisBuilder CrosshairTooltip(ChartCrosshairTooltip crosshairTooltip)
Parameters
Returns
Declaration
public ChartAxisBuilder CrosshairTooltip(Action<ChartCrosshairTooltipBuilder> crosshairTooltip)
Parameters
Returns
Description(String)
Description for axis and its element.
Declaration
public ChartAxisBuilder Description(string description)
Parameters
| Type |
Name |
Description |
| System.String |
description |
|
Returns
DesiredIntervals(Double)
With this property, you can request axis to calculate intervals approximately equal to your specified interval.
Declaration
public ChartAxisBuilder DesiredIntervals(double desiredIntervals)
Parameters
| Type |
Name |
Description |
| System.Double |
desiredIntervals |
|
Returns
EdgeLabelPlacement(EdgeLabelPlacement)
Specifies the position of labels at the edge of the axis.They are,
None: No action will be performed.
Hide: Edge label will be hidden.
Shift: Shifts the edge labels.
Declaration
public ChartAxisBuilder EdgeLabelPlacement(EdgeLabelPlacement edgeLabelPlacement)
Parameters
Returns
EnableAutoIntervalOnZooming(Boolean)
If set to true, axis interval will be calculated automatically with respect to the zoomed range.
Declaration
public ChartAxisBuilder EnableAutoIntervalOnZooming(bool enableAutoIntervalOnZooming)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableAutoIntervalOnZooming |
|
Returns
Enables the scrollbar for zooming.
Declaration
public ChartAxisBuilder EnableScrollbarOnZooming(bool enableScrollbarOnZooming)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableScrollbarOnZooming |
|
Returns
EnableTrim(Boolean)
Specifies the Trim property for an axis.
Declaration
public ChartAxisBuilder EnableTrim(bool enableTrim)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableTrim |
|
Returns
Interval(Double)
Specifies the interval for an axis.
Declaration
public ChartAxisBuilder Interval(double interval)
Parameters
| Type |
Name |
Description |
| System.Double |
interval |
|
Returns
IntervalType(IntervalType)
Specifies the types like Years, Months, Days, Hours, Minutes, Seconds in date time axis.They are,
Auto: Defines the interval of the axis based on data.
Years: Defines the interval of the axis in years.
Months: Defines the interval of the axis in months.
Days: Defines the interval of the axis in days.
Hours: Defines the interval of the axis in hours.
Minutes: Defines the interval of the axis in minutes.
Declaration
public ChartAxisBuilder IntervalType(IntervalType intervalType)
Parameters
Returns
IsIndexed(Boolean)
Specifies indexed category axis.
Declaration
public ChartAxisBuilder IsIndexed(bool isIndexed)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isIndexed |
|
Returns
IsInversed(Boolean)
It specifies whether the axis to be rendered in inversed manner or not.
Declaration
public ChartAxisBuilder IsInversed(bool isInversed)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isInversed |
|
Returns
Used to format the axis label that accepts any global string format like 'C', 'n1', 'P' etc.
It also accepts placeholder like '{value}°C' in which value represent the axis label, e.g, 20°C.
Declaration
public ChartAxisBuilder LabelFormat(string labelFormat)
Parameters
| Type |
Name |
Description |
| System.String |
labelFormat |
|
Returns
LabelIntersectAction(LabelIntersectAction)
Specifies the actions like None, Hide, Trim, Wrap, MultipleRows, Rotate45, and Rotate90
when the axis labels intersect with each other.They are,
None: Shows all the labels.
Hide: Hides the label when it intersects.
Trim: Trim the label when it intersects.
Wrap: Wrap the label when it intersects.
MultipleRows: Shows the label in MultipleRows when it intersects.
Rotate45: Rotates the label to 45 degree when it intersects.
Rotate90: Rotates the label to 90 degree when it intersects.
Declaration
public ChartAxisBuilder LabelIntersectAction(LabelIntersectAction labelIntersectAction)
Parameters
Returns
LabelPadding(Double)
Specifies the labelPadding from axis.
Declaration
public ChartAxisBuilder LabelPadding(double labelPadding)
Parameters
| Type |
Name |
Description |
| System.Double |
labelPadding |
|
Returns
LabelPlacement(LabelPlacement)
Specifies the placement of a label for category axis. They are,
betweenTicks: Renders the label between the ticks.
onTicks: Renders the label on the ticks.
Declaration
public ChartAxisBuilder LabelPlacement(LabelPlacement labelPlacement)
Parameters
Returns
LabelPosition(AxisPosition)
Specifies the placement of a labels to the axis line. They are,
inside: Renders the labels inside to the axis line.
outside: Renders the labels outside to the axis line.
Declaration
public ChartAxisBuilder LabelPosition(AxisPosition labelPosition)
Parameters
Returns
LabelRotation(Double)
The angle to which the axis label gets rotated.
Declaration
public ChartAxisBuilder LabelRotation(double labelRotation)
Parameters
| Type |
Name |
Description |
| System.Double |
labelRotation |
|
Returns
LabelStyle(ChartFont)
Options to customize the axis label.
Declaration
public ChartAxisBuilder LabelStyle(ChartFont labelStyle)
Parameters
Returns
LabelStyle(Action<ChartFontBuilder>)
Declaration
public ChartAxisBuilder LabelStyle(Action<ChartFontBuilder> labelStyle)
Parameters
Returns
LineBreakAlignment(TextAlignment)
It specifies alignment of the line break labels.
Declaration
public ChartAxisBuilder LineBreakAlignment(TextAlignment lineBreakAlignment)
Parameters
Returns
LineStyle(ChartAxisLine)
Options for customizing axis lines.
Declaration
public ChartAxisBuilder LineStyle(ChartAxisLine lineStyle)
Parameters
Returns
LineStyle(Action<ChartAxisLineBuilder>)
Declaration
public ChartAxisBuilder LineStyle(Action<ChartAxisLineBuilder> lineStyle)
Parameters
Returns
LogBase(Double)
The base value for logarithmic axis. It requires valueType to be Logarithmic.
Declaration
public ChartAxisBuilder LogBase(double logBase)
Parameters
| Type |
Name |
Description |
| System.Double |
logBase |
|
Returns
MajorGridLines(ChartMajorGridLines)
Options for customizing major grid lines.
Declaration
public ChartAxisBuilder MajorGridLines(ChartMajorGridLines majorGridLines)
Parameters
Returns
MajorGridLines(Action<ChartMajorGridLinesBuilder>)
Declaration
public ChartAxisBuilder MajorGridLines(Action<ChartMajorGridLinesBuilder> majorGridLines)
Parameters
Returns
MajorTickLines(ChartMajorTickLines)
Options for customizing major tick lines.
Declaration
public ChartAxisBuilder MajorTickLines(ChartMajorTickLines majorTickLines)
Parameters
Returns
MajorTickLines(Action<ChartMajorTickLinesBuilder>)
Declaration
public ChartAxisBuilder MajorTickLines(Action<ChartMajorTickLinesBuilder> majorTickLines)
Parameters
Returns
Maximum(Object)
Specifies the maximum range of an axis.
Declaration
public ChartAxisBuilder Maximum(object maximum)
Parameters
| Type |
Name |
Description |
| System.Object |
maximum |
|
Returns
MaximumLabels(Double)
The maximum number of label count per 100 pixels with respect to the axis length.
Declaration
public ChartAxisBuilder MaximumLabels(double maximumLabels)
Parameters
| Type |
Name |
Description |
| System.Double |
maximumLabels |
|
Returns
MaximumLabelWidth(Double)
Specifies the maximum width of an axis label.
Declaration
public ChartAxisBuilder MaximumLabelWidth(double maximumLabelWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
maximumLabelWidth |
|
Returns
Minimum(Object)
Specifies the minimum range of an axis.
Declaration
public ChartAxisBuilder Minimum(object minimum)
Parameters
| Type |
Name |
Description |
| System.Object |
minimum |
|
Returns
MinorGridLines(ChartMinorGridLines)
Options for customizing minor grid lines.
Declaration
public ChartAxisBuilder MinorGridLines(ChartMinorGridLines minorGridLines)
Parameters
Returns
MinorGridLines(Action<ChartMinorGridLinesBuilder>)
Declaration
public ChartAxisBuilder MinorGridLines(Action<ChartMinorGridLinesBuilder> minorGridLines)
Parameters
Returns
MinorTickLines(ChartMinorTickLines)
Options for customizing minor tick lines.
Declaration
public ChartAxisBuilder MinorTickLines(ChartMinorTickLines minorTickLines)
Parameters
Returns
MinorTickLines(Action<ChartMinorTickLinesBuilder>)
Declaration
public ChartAxisBuilder MinorTickLines(Action<ChartMinorTickLinesBuilder> minorTickLines)
Parameters
Returns
MinorTicksPerInterval(Double)
Specifies the number of minor ticks per interval.
Declaration
public ChartAxisBuilder MinorTicksPerInterval(double minorTicksPerInterval)
Parameters
| Type |
Name |
Description |
| System.Double |
minorTicksPerInterval |
|
Returns
MultiLevelLabels(Action<ChartMultiLevelLabelBuilder>)
Declaration
public ChartAxisBuilder MultiLevelLabels(Action<ChartMultiLevelLabelBuilder> multiLevelLabels)
Parameters
Returns
MultiLevelLabels(List<ChartMultiLevelLabel>)
Specifies the multi level labels collection for the axis.
Declaration
public ChartAxisBuilder MultiLevelLabels(List<ChartMultiLevelLabel> multiLevelLabels)
Parameters
Returns
Name(String)
Unique identifier of an axis.
To associate an axis with the series, set this name to the xAxisName/yAxisName properties of the series.
Declaration
public ChartAxisBuilder Name(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Returns
OpposedPosition(Boolean)
If set to true, the axis will render at the opposite side of its default position.
Declaration
public ChartAxisBuilder OpposedPosition(bool opposedPosition)
Parameters
| Type |
Name |
Description |
| System.Boolean |
opposedPosition |
|
Returns
PlaceNextToAxisLine(Boolean)
Specifies whether axis elements like axis labels, axis title, etc has to be crossed with axis line.
Declaration
public ChartAxisBuilder PlaceNextToAxisLine(bool placeNextToAxisLine)
Parameters
| Type |
Name |
Description |
| System.Boolean |
placeNextToAxisLine |
|
Returns
PlotOffset(Double)
Left and right padding for the plot area in pixels.
Declaration
public ChartAxisBuilder PlotOffset(double plotOffset)
Parameters
| Type |
Name |
Description |
| System.Double |
plotOffset |
|
Returns
PlotOffsetBottom(Double)
Bottom padding for the plot area in pixels.
Declaration
public ChartAxisBuilder PlotOffsetBottom(double plotOffsetBottom)
Parameters
| Type |
Name |
Description |
| System.Double |
plotOffsetBottom |
|
Returns
PlotOffsetLeft(Double)
Left padding for the plot area in pixels.
Declaration
public ChartAxisBuilder PlotOffsetLeft(double plotOffsetLeft)
Parameters
| Type |
Name |
Description |
| System.Double |
plotOffsetLeft |
|
Returns
PlotOffsetRight(Double)
Right padding for the plot area in pixels.
Declaration
public ChartAxisBuilder PlotOffsetRight(double plotOffsetRight)
Parameters
| Type |
Name |
Description |
| System.Double |
plotOffsetRight |
|
Returns
PlotOffsetTop(Double)
Top padding for the plot area in pixels.
Declaration
public ChartAxisBuilder PlotOffsetTop(double plotOffsetTop)
Parameters
| Type |
Name |
Description |
| System.Double |
plotOffsetTop |
|
Returns
RangePadding(ChartRangePadding)
Specifies the padding for the axis range in terms of interval.They are,
none: Padding cannot be applied to the axis.
normal: Padding is applied to the axis based on the range calculation.
additional: Interval of the axis is added as padding to the minimum and maximum values of the range.
round: Axis range is rounded to the nearest possible value divided by the interval.
Declaration
public ChartAxisBuilder RangePadding(ChartRangePadding rangePadding)
Parameters
Returns
RowIndex(Double)
Specifies the index of the row where the axis is associated, when the chart area is divided into multiple plot areas by using rows.
Declaration
public ChartAxisBuilder RowIndex(double rowIndex)
Parameters
| Type |
Name |
Description |
| System.Double |
rowIndex |
|
Returns
Option to customize scrollbar with lazy loading.
Declaration
public ChartAxisBuilder ScrollbarSettings(ChartScrollbarSettings scrollbarSettings)
Parameters
Returns
Declaration
public ChartAxisBuilder ScrollbarSettings(Action<ChartScrollbarSettingsBuilder> scrollbarSettings)
Parameters
Returns
Skeleton(String)
Specifies the skeleton format in which the dateTime format will process.
Declaration
public ChartAxisBuilder Skeleton(string skeleton)
Parameters
| Type |
Name |
Description |
| System.String |
skeleton |
|
Returns
SkeletonType(SkeletonType)
It specifies the type of format to be used in dateTime format process.
Declaration
public ChartAxisBuilder SkeletonType(SkeletonType skeletonType)
Parameters
Returns
Span(Double)
Specifies the number of columns or rows an axis has to span horizontally or vertically.
Declaration
public ChartAxisBuilder Span(double span)
Parameters
| Type |
Name |
Description |
| System.Double |
span |
|
Returns
StartAngle(Double)
The start angle for the series.
Declaration
public ChartAxisBuilder StartAngle(double startAngle)
Parameters
| Type |
Name |
Description |
| System.Double |
startAngle |
|
Returns
StartFromZero(Boolean)
It specifies whether the axis to be start from zero.
Declaration
public ChartAxisBuilder StartFromZero(bool startFromZero)
Parameters
| Type |
Name |
Description |
| System.Boolean |
startFromZero |
|
Returns
StripLines(Action<ChartStripLineBuilder>)
Declaration
public ChartAxisBuilder StripLines(Action<ChartStripLineBuilder> stripLines)
Parameters
Returns
StripLines(List<ChartStripLine>)
Specifies the stripLine collection for the axis.
Declaration
public ChartAxisBuilder StripLines(List<ChartStripLine> stripLines)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<ChartStripLine> |
stripLines |
|
Returns
TabIndex(Double)
TabIndex value for the axis.
Declaration
public ChartAxisBuilder TabIndex(double tabIndex)
Parameters
| Type |
Name |
Description |
| System.Double |
tabIndex |
|
Returns
TickPosition(AxisPosition)
Specifies the placement of a ticks to the axis line. They are,
inside: Renders the ticks inside to the axis line.
outside: Renders the ticks outside to the axis line.
Declaration
public ChartAxisBuilder TickPosition(AxisPosition tickPosition)
Parameters
Returns
Title(String)
Specifies the title of an axis.
Declaration
public ChartAxisBuilder Title(string title)
Parameters
| Type |
Name |
Description |
| System.String |
title |
|
Returns
TitlePadding(Double)
Specifies the titlePadding from axis label.
Declaration
public ChartAxisBuilder TitlePadding(double titlePadding)
Parameters
| Type |
Name |
Description |
| System.Double |
titlePadding |
|
Returns
TitleRotation(Double)
Defines an angle to rotate axis title. By default, angle auto calculated based on position and orientation of axis.
Declaration
public ChartAxisBuilder TitleRotation(double titleRotation)
Parameters
| Type |
Name |
Description |
| System.Double |
titleRotation |
|
Returns
TitleStyle(ChartFont)
Options for customizing the axis title.
Declaration
public ChartAxisBuilder TitleStyle(ChartFont titleStyle)
Parameters
Returns
TitleStyle(Action<ChartFontBuilder>)
Declaration
public ChartAxisBuilder TitleStyle(Action<ChartFontBuilder> titleStyle)
Parameters
Returns
ValueType(ValueType)
Specifies the data types that the axis can handle:
Double: This type is used for rendering a numeric axis to accommodate numeric data.
DateTime: This type is utilized for rendering a date-time axis to manage date-time data.
Category: This type is employed for rendering a category axis to manage categorical data.
Logarithmic: This type is applied for rendering a logarithmic axis to handle a wide range of values.
DateTimeCategory: This type is used to render a date time category axis for managing business days.
Declaration
public ChartAxisBuilder ValueType(ValueType valueType)
Parameters
Returns
Visible(Boolean)
If set to true, axis label will be visible.
Declaration
public ChartAxisBuilder Visible(bool visible)
Parameters
| Type |
Name |
Description |
| System.Boolean |
visible |
|
Returns
ZoomFactor(Double)
The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1.
Declaration
public ChartAxisBuilder ZoomFactor(double zoomFactor)
Parameters
| Type |
Name |
Description |
| System.Double |
zoomFactor |
|
Returns
ZoomPosition(Double)
Position of the zoomed axis. Value ranges from 0 to 1.
Declaration
public ChartAxisBuilder ZoomPosition(double zoomPosition)
Parameters
| Type |
Name |
Description |
| System.Double |
zoomPosition |
|
Returns
