Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / ChartOHLCSeriesBuilder<T>
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

ChartOHLCSeriesBuilder<T>

Class

Defines the fluent interface for configuring bar series.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

T

The type of the data item

Syntax:
C#
public class ChartOHLCSeriesBuilder<T> : ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>> where T : class

Inheritance: objectChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>ChartOHLCSeriesBuilder<T>

Derived Classes: ChartCandlestickSeriesBuilder<T>

Inherited Members ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Name(string)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Opacity(double)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Color(string)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.ColorHandler(Func<object, object>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.ColorHandler(string)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Tooltip(Action<ChartTooltipBuilder>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Tooltip(bool)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Axis(string)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.CategoryAxis(string)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Highlight(Action<ChartSeriesHighlightBuilder>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.FocusHighlight(Action<ChartSeriesFocusHighlightSettingsBuilder>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Highlight(bool)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Visible(bool)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.VisibleInLegend(bool)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Notes(Action<ChartNoteBuilder>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Aggregate(Func<object, object>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Aggregate(string)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.ZIndex(double)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Median(Action<ChartSeriesMedianBuilder>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Mean(Action<ChartSeriesMeanBuilder>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.DrilldownField(string)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.DrilldownSeriesFactory(string)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.DrilldownSeriesFactory(Func<object, object>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.LegendItem(Action<ChartSeriesLegendItemSettingsBuilder>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Pattern(Action<ChartSeriesPatternSettingsBuilder>)ChartSeriesBuilderBase<IChartOHLCSeries, ChartOHLCSeriesBuilder<T>>.Seriesobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ChartOHLCSeriesBuilder(IChartOHLCSeries)

Initializes a new instance of the ChartOHLCSeriesBuilder<T> class.

C#
public ChartOHLCSeriesBuilder(IChartOHLCSeries series)
Parameters:seriesIChartOHLCSeries

The series.

Methods

Aggregate(ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?)

Sets the aggregate function for date series. This function is used when a category (an year, month, etc.) contains two or more points.

C#
public ChartOHLCSeriesBuilder<T> Aggregate(ChartSeriesAggregate? open = null, ChartSeriesAggregate? high = null, ChartSeriesAggregate? low = null, ChartSeriesAggregate? close = null)
Parameters:openChartSeriesAggregate?

Open aggregate name.

highChartSeriesAggregate?

High aggregate name.

lowChartSeriesAggregate?

Low aggregate name.

closeChartSeriesAggregate?

Close aggregate name.

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.OHLC(s =&gt; s.Sales).Aggregate(ChartSeriesAggregate.Avg))
)

Border(int, string, ChartDashType)

Sets the points border

C#
public ChartOHLCSeriesBuilder<T> Border(int width, string color, ChartDashType dashType)
Parameters:widthint

The points border width.

colorstring

The points border color (CSS syntax).

dashTypeChartDashType

The points border dash type.

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.OHLC(s =&gt; s.Sales).Border("1", "#000", ChartDashType.Dot))
)

CloseField(string)

Sets the close field for the series

C#
public ChartOHLCSeriesBuilder<T> CloseField(string closeField)
Parameters:closeFieldstring

The close field for the series

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close"))
)

ColorField(string)

Sets the color field for the series

C#
public ChartOHLCSeriesBuilder<T> ColorField(string colorField)
Parameters:colorFieldstring

The color field for the series

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close").ColorField("Color"))
)

Fields(string, string, string, string)

Sets the value fields for the series

C#
public ChartOHLCSeriesBuilder<T> Fields(string openField, string highField, string lowField, string closeField)
Parameters:openFieldstring

The open field for the series

highFieldstring

The value fields for the series

lowFieldstring

The low field for the series

closeFieldstring

The close field for the series

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.OHLC(Model.Records).Fields("Open", "High", "Low", "Close"))
)

Gap(double)

Set distance between category clusters.

A value of 1 means that there is a total of 1 point width between categories. The distance is distributed evenly on each side. The default value is 1
C#
public ChartOHLCSeriesBuilder<T> Gap(double gap)
Parameters:gapdoubleReturns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.OHLC(s =&gt; s.Sales).Gap(1.5))
)

HighField(string)

Sets the high field for the series

C#
public ChartOHLCSeriesBuilder<T> HighField(string highField)
Parameters:highFieldstring

The high field for the series

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close"))
)

Highlight(Action<ChartOHLCSeriesHighlightBuilder>)

Configures the series highlight

C#
public ChartOHLCSeriesBuilder<T> Highlight(Action<ChartOHLCSeriesHighlightBuilder> configurator)
Parameters:configuratorAction<ChartOHLCSeriesHighlightBuilder>

The configuration action.

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.Area(s =&gt; s.Sales)
.Highlight(highlight =&gt; highlight.Line(2, "yellow"))
)
)

Line(Action<ChartLineBuilder>)

Configures the ohlc chart lines.

C#
public ChartOHLCSeriesBuilder<T> Line(Action<ChartLineBuilder> configurator)
Parameters:configuratorAction<ChartLineBuilder>

The configuration action.

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.Area(s =&gt; s.Sales)
.Line(line =&gt; line.Opacity(0.2))
)
)

Line(int, string, ChartDashType)

Configures the ohlc chart lines.

C#
public ChartOHLCSeriesBuilder<T> Line(int width, string color, ChartDashType dashType)
Parameters:widthint

The lines width.

colorstring

The lines color.

dashTypeChartDashType

The lines dashType.

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.OHLC(s =&gt; s.Sales)
.Line(2, "red", ChartDashType.Dot)
)
)

Line(int, string)

Configures the ohlc lines.

C#
public ChartOHLCSeriesBuilder<T> Line(int width, string color)
Parameters:widthint

The lines width.

colorstring

The lines color.

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.Area(s =&gt; s.Sales)
.Line(2, "orange")
)
)

Line(int)

Configures the ohlc line width.

C#
public ChartOHLCSeriesBuilder<T> Line(int width)
Parameters:widthint

The lines width.

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.Area(s =&gt; s.Sales)
.Line(2)
)
)

LowField(string)

Sets the low field for the series

C#
public ChartOHLCSeriesBuilder<T> LowField(string lowField)
Parameters:lowFieldstring

The low field for the series

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close"))
)

NoteTextField(string)

Sets the note text field for the series

C#
public ChartOHLCSeriesBuilder<T> NoteTextField(string noteTextField)
Parameters:noteTextFieldstring

The note text field for the series

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close").NoteTextField("NoteText"))
)

OpenField(string)

Sets the open field for the series

C#
public ChartOHLCSeriesBuilder<T> OpenField(string openField)
Parameters:openFieldstring

The open field for the series

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close"))
)

Spacing(double)

Sets a value indicating the distance between points in the same category.

C#
public ChartOHLCSeriesBuilder<T> Spacing(double spacing)
Parameters:spacingdouble

Value of 1 means that the distance between points in the same category. The default value is 0.3

Returns:

ChartOHLCSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.Spacing(s =&gt; s.Sales).Spacing(1))
)
In this article
DefinitionConstructorsChartOHLCSeriesBuilder(IChartOHLCSeries)MethodsAggregate(ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?)Border(int, string, ChartDashType)CloseField(string)ColorField(string)Fields(string, string, string, string)Gap(double)HighField(string)Highlight(Action<ChartOHLCSeriesHighlightBuilder>)Line(Action<ChartLineBuilder>)Line(int, string, ChartDashType)Line(int, string)Line(int)LowField(string)NoteTextField(string)OpenField(string)Spacing(double)
Not finding the help you need?
Contact Support