Class ChartSeriesBuilder
Inheritance
System.Object
ChartSeriesBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChartSeriesBuilder : ControlBuilder
Constructors
ChartSeriesBuilder()
Declaration
public ChartSeriesBuilder()
ChartSeriesBuilder(List<ChartSeries>)
Declaration
public ChartSeriesBuilder(List<ChartSeries> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<ChartSeries> |
collection |
|
Methods
Add()
Declaration
Animation(ChartAnimation)
Options to customizing animation for the series.
Declaration
public ChartSeriesBuilder Animation(ChartAnimation animation)
Parameters
Returns
Animation(Action<ChartAnimationBuilder>)
Declaration
public ChartSeriesBuilder Animation(Action<ChartAnimationBuilder> animation)
Parameters
Returns
BearFillColor(String)
This property is used in financial charts to visualize the price movements in stock.
It defines the color of the candle/point, when the opening price is less than the closing price.
Declaration
public ChartSeriesBuilder BearFillColor(string bearFillColor)
Parameters
| Type |
Name |
Description |
| System.String |
bearFillColor |
|
Returns
BinInterval(Double)
The bin interval of each histogram points.
Declaration
public ChartSeriesBuilder BinInterval(double binInterval)
Parameters
| Type |
Name |
Description |
| System.Double |
binInterval |
|
Returns
Border(ChartBorder)
Options to customizing the border of the series. This is applicable only for Column and Bar type series.
Declaration
public ChartSeriesBuilder Border(ChartBorder border)
Parameters
Returns
Border(Action<ChartBorderBuilder>)
Declaration
public ChartSeriesBuilder Border(Action<ChartBorderBuilder> border)
Parameters
Returns
BoxPlotMode(BoxPlotMode)
The mode of the box and whisker char series. They are,
Exclusive
Inclusive
Normal
Declaration
public ChartSeriesBuilder BoxPlotMode(BoxPlotMode boxPlotMode)
Parameters
Returns
BullFillColor(String)
This property is used in financial charts to visualize the price movements in stock.
It defines the color of the candle/point, when the opening price is higher than the closing price.
Declaration
public ChartSeriesBuilder BullFillColor(string bullFillColor)
Parameters
| Type |
Name |
Description |
| System.String |
bullFillColor |
|
Returns
CardinalSplineTension(Double)
It defines tension of cardinal spline types.
Declaration
public ChartSeriesBuilder CardinalSplineTension(double cardinalSplineTension)
Parameters
| Type |
Name |
Description |
| System.Double |
cardinalSplineTension |
|
Returns
Close(String)
The DataSource field that contains the close value of y
It is applicable for series and technical indicators
Declaration
public ChartSeriesBuilder Close(string close)
Parameters
| Type |
Name |
Description |
| System.String |
close |
|
Returns
ColorName(String)
The Data Source field that contains the color mapping value.
It is applicable for range color mapping properly.
Declaration
public ChartSeriesBuilder ColorName(string colorName)
Parameters
| Type |
Name |
Description |
| System.String |
colorName |
|
Returns
ColumnFacet(ShapeType)
Defines the shape of the data in a column and bar chart.
Rectangle: Displays the data in a column and bar chart in a rectangle shape.
Cylinder: Displays the data in a column and bar chart in a cylinder shape.
Declaration
public ChartSeriesBuilder ColumnFacet(ShapeType columnFacet)
Parameters
Returns
ColumnSpacing(Double)
To render the column series points with particular column spacing. It takes value from 0 - 1.
Declaration
public ChartSeriesBuilder ColumnSpacing(double columnSpacing)
Parameters
| Type |
Name |
Description |
| System.Double |
columnSpacing |
|
Returns
ColumnWidth(Double)
To render the column series points with particular column width. If the series type is histogram the
default value is 1 otherwise 0.7.
Declaration
public ChartSeriesBuilder ColumnWidth(double columnWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
columnWidth |
|
Returns
ColumnWidthInPixel(Double)
To render the column series points with particular column width as pixel.
Declaration
public ChartSeriesBuilder ColumnWidthInPixel(double columnWidthInPixel)
Parameters
| Type |
Name |
Description |
| System.Double |
columnWidthInPixel |
|
Returns
Connector(Object)
Defines the appearance of line connecting adjacent points in waterfall charts.
Declaration
public ChartSeriesBuilder Connector(object connector)
Parameters
| Type |
Name |
Description |
| System.Object |
connector |
|
Returns
CornerRadius(ChartCornerRadius)
To render the column series points with particular rounded corner.
Declaration
public ChartSeriesBuilder CornerRadius(ChartCornerRadius cornerRadius)
Parameters
Returns
CornerRadius(Action<ChartCornerRadiusBuilder>)
Declaration
public ChartSeriesBuilder CornerRadius(Action<ChartCornerRadiusBuilder> cornerRadius)
Parameters
Returns
DashArray(String)
Defines the pattern of dashes and gaps to stroke the lines in Line type series.
Declaration
public ChartSeriesBuilder DashArray(string dashArray)
Parameters
| Type |
Name |
Description |
| System.String |
dashArray |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public ChartSeriesBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Returns
DataSource(Object)
Specifies the DataSource for the series. It can be an array of JSON objects or an instance of DataManager.
Declaration
public ChartSeriesBuilder DataSource(object dataSource)
Parameters
| Type |
Name |
Description |
| System.Object |
dataSource |
|
Returns
DragSettings(ChartDragSettings)
Options to customize the drag settings for series
Declaration
public ChartSeriesBuilder DragSettings(ChartDragSettings dragSettings)
Parameters
Returns
DragSettings(Action<ChartDragSettingsBuilder>)
Declaration
public ChartSeriesBuilder DragSettings(Action<ChartDragSettingsBuilder> dragSettings)
Parameters
Returns
DrawType(ChartDrawType)
Type of series to be drawn in radar or polar series. They are
'Line'
'Column'
'Area'
'Scatter'
'Spline'
'StackingColumn'
'StackingArea'
'RangeColumn'
'SplineArea'
Declaration
public ChartSeriesBuilder DrawType(ChartDrawType drawType)
Parameters
Returns
EmptyPointSettings(ChartEmptyPointSettings)
options to customize the empty points in series.
Declaration
public ChartSeriesBuilder EmptyPointSettings(ChartEmptyPointSettings emptyPointSettings)
Parameters
Returns
EmptyPointSettings(Action<ChartEmptyPointSettingsBuilder>)
Declaration
public ChartSeriesBuilder EmptyPointSettings(Action<ChartEmptyPointSettingsBuilder> emptyPointSettings)
Parameters
Returns
EnableComplexProperty(Boolean)
This property used to improve chart performance via data mapping for series dataSource.
Declaration
public ChartSeriesBuilder EnableComplexProperty(bool enableComplexProperty)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableComplexProperty |
|
Returns
EnableSolidCandles(Boolean)
This property is applicable for candle series.
It enables/disables to visually compare the current values with the previous values in stock.
Declaration
public ChartSeriesBuilder EnableSolidCandles(bool enableSolidCandles)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableSolidCandles |
|
Returns
If set true, the Tooltip for series will be visible.
Declaration
public ChartSeriesBuilder EnableTooltip(bool enableTooltip)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableTooltip |
|
Returns
ErrorBar(ChartErrorBarSettings)
Options for displaying and customizing error bar for individual point in a series.
Declaration
public ChartSeriesBuilder ErrorBar(ChartErrorBarSettings errorBar)
Parameters
Returns
ErrorBar(Action<ChartErrorBarSettingsBuilder>)
Declaration
public ChartSeriesBuilder ErrorBar(Action<ChartErrorBarSettingsBuilder> errorBar)
Parameters
Returns
Fill(String)
The fill color for the series that accepts value in hex and rgba as a valid CSS color string.
It also represents the color of the signal lines in technical indicators.
For technical indicators, the default value is 'blue' and for series, it has null.
Declaration
public ChartSeriesBuilder Fill(string fill)
Parameters
| Type |
Name |
Description |
| System.String |
fill |
|
Returns
GroupName(String)
Defines the name that specifies the chart series are mutually exclusive and can be overlaid.
The axis in the same group shares the same baseline and location on the corresponding axis.
Declaration
public ChartSeriesBuilder GroupName(string groupName)
Parameters
| Type |
Name |
Description |
| System.String |
groupName |
|
Returns
High(String)
The DataSource field that contains the high value of y
It is applicable for series and technical indicators
Declaration
public ChartSeriesBuilder High(string high)
Parameters
| Type |
Name |
Description |
| System.String |
high |
|
Returns
Defines the collection of indexes of the intermediate summary columns in waterfall charts.
Declaration
public ChartSeriesBuilder IntermediateSumIndexes(int[] intermediateSumIndexes)
Parameters
| Type |
Name |
Description |
| System.Int32[] |
intermediateSumIndexes |
|
Returns
IsClosed(Boolean)
Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path.
Declaration
public ChartSeriesBuilder IsClosed(bool isClosed)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isClosed |
|
Returns
LegendImageUrl(String)
The URL for the Image that is to be displayed as a Legend icon. It requires legendShape value to be an Image.
Declaration
public ChartSeriesBuilder LegendImageUrl(string legendImageUrl)
Parameters
| Type |
Name |
Description |
| System.String |
legendImageUrl |
|
Returns
LegendShape(LegendShape)
The shape of the legend. Each series has its own legend shape. They are,
Circle
Rectangle
Triangle
Diamond
Cross
HorizontalLine
VerticalLine
Pentagon
InvertedTriangle
SeriesType
Image
Declaration
public ChartSeriesBuilder LegendShape(LegendShape legendShape)
Parameters
Returns
Low(String)
The DataSource field that contains the low value of y
It is applicable for series and technical indicators
Declaration
public ChartSeriesBuilder Low(string low)
Parameters
| Type |
Name |
Description |
| System.String |
low |
|
Returns
Marker(ChartMarkerSettings)
Options for displaying and customizing markers for individual points in a series.
Declaration
public ChartSeriesBuilder Marker(ChartMarkerSettings marker)
Parameters
Returns
Marker(Action<ChartMarkerSettingsBuilder>)
Declaration
public ChartSeriesBuilder Marker(Action<ChartMarkerSettingsBuilder> marker)
Parameters
Returns
MaxRadius(Double)
Declaration
public ChartSeriesBuilder MaxRadius(double maxRadius)
Parameters
| Type |
Name |
Description |
| System.Double |
maxRadius |
|
Returns
MinRadius(Double)
Declaration
public ChartSeriesBuilder MinRadius(double minRadius)
Parameters
| Type |
Name |
Description |
| System.Double |
minRadius |
|
Returns
Name(String)
The name of the series visible in legend.
Declaration
public ChartSeriesBuilder Name(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Returns
NegativeFillColor(String)
Defines the visual representation of the negative changes in waterfall charts.
Declaration
public ChartSeriesBuilder NegativeFillColor(string negativeFillColor)
Parameters
| Type |
Name |
Description |
| System.String |
negativeFillColor |
|
Returns
NonHighlightStyle(String)
Custom style for the non-highlighted series or points.
Declaration
public ChartSeriesBuilder NonHighlightStyle(string nonHighlightStyle)
Parameters
| Type |
Name |
Description |
| System.String |
nonHighlightStyle |
|
Returns
Opacity(Double)
The opacity of the series.
Declaration
public ChartSeriesBuilder Opacity(double opacity)
Parameters
| Type |
Name |
Description |
| System.Double |
opacity |
|
Returns
Open(String)
The DataSource field that contains the open value of y
It is applicable for series and technical indicators
Declaration
public ChartSeriesBuilder Open(string open)
Parameters
| Type |
Name |
Description |
| System.String |
open |
|
Returns
ParetoOptions(ChartParetoOptions)
Options for customizing the pareto line series.
Declaration
public ChartSeriesBuilder ParetoOptions(ChartParetoOptions paretoOptions)
Parameters
Returns
ParetoOptions(Action<ChartParetoOptionsBuilder>)
Declaration
public ChartSeriesBuilder ParetoOptions(Action<ChartParetoOptionsBuilder> paretoOptions)
Parameters
Returns
PointColorMapping(String)
The DataSource field that contains the color value of point
It is applicable for series
Declaration
public ChartSeriesBuilder PointColorMapping(string pointColorMapping)
Parameters
| Type |
Name |
Description |
| System.String |
pointColorMapping |
|
Returns
Query(String)
Specifies query to select data from DataSource. This property is applicable only when the DataSource is ej.DataManager.
Declaration
public ChartSeriesBuilder Query(string query)
Parameters
| Type |
Name |
Description |
| System.String |
query |
|
Returns
SegmentAxis(Segment)
Defines the axis, based on which the line series will be split.
Declaration
public ChartSeriesBuilder SegmentAxis(Segment segmentAxis)
Parameters
| Type |
Name |
Description |
| Segment |
segmentAxis |
|
Returns
Segments(Action<ChartSegmentBuilder>)
Declaration
public ChartSeriesBuilder Segments(Action<ChartSegmentBuilder> segments)
Parameters
Returns
Segments(List<ChartSegment>)
Defines the collection of regions that helps to differentiate a line series.
Declaration
public ChartSeriesBuilder Segments(List<ChartSegment> segments)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<ChartSegment> |
segments |
|
Returns
SelectionStyle(String)
Custom style for the selected series or points.
Declaration
public ChartSeriesBuilder SelectionStyle(string selectionStyle)
Parameters
| Type |
Name |
Description |
| System.String |
selectionStyle |
|
Returns
ShowMean(Boolean)
If set true, the mean value for box and whisker will be visible.
Declaration
public ChartSeriesBuilder ShowMean(bool showMean)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showMean |
|
Returns
ShowNormalDistribution(Boolean)
The normal distribution of histogram series.
Declaration
public ChartSeriesBuilder ShowNormalDistribution(bool showNormalDistribution)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showNormalDistribution |
|
Returns
Size(String)
The DataSource field that contains the size value of y
Declaration
public ChartSeriesBuilder Size(string size)
Parameters
| Type |
Name |
Description |
| System.String |
size |
|
Returns
SplineType(SplineType)
Defines type of spline to be rendered.
Declaration
public ChartSeriesBuilder SplineType(SplineType splineType)
Parameters
Returns
StackingGroup(String)
This property allows grouping series in stacked column / bar charts.
Any string value can be provided to the stackingGroup property.
If any two or above series have the same value, those series will be grouped together.
Declaration
public ChartSeriesBuilder StackingGroup(string stackingGroup)
Parameters
| Type |
Name |
Description |
| System.String |
stackingGroup |
|
Returns
SumIndexes(Int32[])
Defines the collection of indexes of the overall summary columns in waterfall charts.
Declaration
public ChartSeriesBuilder SumIndexes(int[] sumIndexes)
Parameters
| Type |
Name |
Description |
| System.Int32[] |
sumIndexes |
|
Returns
SummaryFillColor(String)
Defines the visual representation of the summaries in waterfall charts.
Declaration
public ChartSeriesBuilder SummaryFillColor(string summaryFillColor)
Parameters
| Type |
Name |
Description |
| System.String |
summaryFillColor |
|
Returns
user can format now each series tooltip format separately.
Declaration
public ChartSeriesBuilder TooltipFormat(string tooltipFormat)
Parameters
| Type |
Name |
Description |
| System.String |
tooltipFormat |
|
Returns
The provided value will be considered as a Tooltip name
Declaration
public ChartSeriesBuilder TooltipMappingName(string tooltipMappingName)
Parameters
| Type |
Name |
Description |
| System.String |
tooltipMappingName |
|
Returns
Trendlines(Action<ChartTrendlineBuilder>)
Declaration
public ChartSeriesBuilder Trendlines(Action<ChartTrendlineBuilder> trendlines)
Parameters
Returns
Trendlines(List<ChartTrendline>)
Defines the collection of trendlines that are used to predict the trend
Declaration
public ChartSeriesBuilder Trendlines(List<ChartTrendline> trendlines)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<ChartTrendline> |
trendlines |
|
Returns
Type(ChartSeriesType)
The type of the series are
Line
Column
Area
Bar
Histogram
StackingColumn
StackingArea
StackingBar
StepLine
StepArea
Scatter
Spline
StackingColumn100
StackingBar100
StackingArea100
RangeColumn
Hilo
HiloOpenClose
Waterfall
RangeArea
SplineRangeArea
Bubble
Candle
Polar
Radar
BoxAndWhisker
Pareto
Declaration
public ChartSeriesBuilder Type(ChartSeriesType type)
Parameters
Returns
UnSelectedStyle(String)
Custom style for the deselected series or points.
Declaration
public ChartSeriesBuilder UnSelectedStyle(string unSelectedStyle)
Parameters
| Type |
Name |
Description |
| System.String |
unSelectedStyle |
|
Returns
Visible(Boolean)
Specifies the visibility of series.
Declaration
public ChartSeriesBuilder Visible(bool visible)
Parameters
| Type |
Name |
Description |
| System.Boolean |
visible |
|
Returns
Volume(String)
Defines the data source field that contains the volume value in candle charts
It is applicable for financial series and technical indicators
Declaration
public ChartSeriesBuilder Volume(string volume)
Parameters
| Type |
Name |
Description |
| System.String |
volume |
|
Returns
Width(Double)
The stroke width for the series that is applicable only for Line type series.
It also represents the stroke width of the signal lines in technical indicators.
Declaration
public ChartSeriesBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
XAxisName(String)
The name of the horizontal axis associated with the series. It requires axes of the chart.
It is applicable for series and technical indicators
Declaration
public ChartSeriesBuilder XAxisName(string xAxisName)
Parameters
| Type |
Name |
Description |
| System.String |
xAxisName |
|
Returns
XName(String)
The DataSource field that contains the x value.
It is applicable for series and technical indicators
Declaration
public ChartSeriesBuilder XName(string xName)
Parameters
| Type |
Name |
Description |
| System.String |
xName |
|
Returns
YAxisName(String)
The name of the vertical axis associated with the series. It requires axes of the chart.
It is applicable for series and technical indicators
Declaration
public ChartSeriesBuilder YAxisName(string yAxisName)
Parameters
| Type |
Name |
Description |
| System.String |
yAxisName |
|
Returns
YName(String)
The DataSource field that contains the y value.
Declaration
public ChartSeriesBuilder YName(string yName)
Parameters
| Type |
Name |
Description |
| System.String |
yName |
|
Returns
ZOrder(Double)
The z order of the series.
Declaration
public ChartSeriesBuilder ZOrder(double zOrder)
Parameters
| Type |
Name |
Description |
| System.Double |
zOrder |
|
Returns
