ChartYAxisBuilder

Methods

Date()

Sets the axis type to date for displaying chronological data.

RETURNS

Returns the current ChartYAxisBuilder instance.

Example

Razor

 
            @(Html.Kendo().Chart(Model)
                .Name("chart")
                .Series(series => {
                    series.ScatterLine(model => model.Date, model => model.Close);
                })
                .YAxis(axis => axis
                    .Date()
                )
            )

Logarithmic()

Sets the axis type to logarithmic.

RETURNS

Returns the current ChartYAxisBuilder instance.

Example

Razor

 
            @(Html.Kendo().Chart()
                .Name("chart")
                .Series(series =>
                {
                    series.Scatter(new int[][] {
                        new[] { 5, 2 },
                        new[] { 7, 2 },
                        new[] { 11123, 2 }
                    });
                 })
                .YAxis(axis => axis
                    .Logarithmic()
                )
            )

Numeric()

Sets the axis type to numeric.

RETURNS

Returns the current ChartYAxisBuilder instance.

Example

Razor

 
            @(Html.Kendo().Chart()
                .Name("chart")
                .Series(series =>
                {
                    series.Scatter(new double[][] {
                        new[] { 16.4, 5.4 },
                        new[] { 21.7, 2 },
                        new[] { 25.4, 3 }
                    });
                 })
                .YAxis(axis => axis
                    .Numeric()
                )
            )

Numeric(System.String)

Sets the axis type to numeric.

Parameters

name - `System.String`

The value that configures the axis name.

RETURNS

Returns the current ChartYAxisBuilder instance.

Example

Razor

 
            @(Html.Kendo().Chart()
                .Name("chart")
                .Series(series =>
                {
                    series.Scatter(new double[][] {
                        new[] { 16.4, 5.4 },
                        new[] { 21.7, 2 },
                        new[] { 25.4, 3 }
                    });
                 })
                .YAxis(axis => axis
                    .Numeric("axis1")
                )
            )

Polar()

Sets the axis type to polar.

RETURNS

Returns the current ChartYAxisBuilder instance.

Example

Razor

 
            @(Html.Kendo().Chart(Model)
                .Name("chart")
                .Series(series =>
                {
                    series.PolarLine(model => model.Azimuth, model => model.Altitude);
                 })
                .YAxis(axis => axis
                    .Polar()
                )
            )

Title(System.String)

Sets the title of the axis.

RETURNS

Returns the current ChartYAxisBuilder instance.

Example

Razor

 
            @(Html.Kendo().Chart()
                .Name("chart")
                .YAxis(axis => axis
                    .Numeric()
                    .Title(title => title.Text("Wind Speed [km/h]"))
                )
            )

AxisCrossingValue(System.Object[])

Value at which the Y axis crosses this axis. (Only for object)Value indices at which the Y axes cross the value axis. (Only for array)Date at which the Y axis crosses this axis. (Only for date)

RETURNS

Returns the current ChartYAxisBuilder instance.

Background(System.String)

The background color of the axis.

RETURNS

Returns the current ChartYAxisBuilder instance.

The base time interval for the axis labels. The default baseUnit is determined automatically from the value range. Available options: milliseconds; seconds; minutes; hours; days; weeks; months or years.

Parameters

value - `System.String`

The value for BaseUnit

RETURNS

Returns the current ChartYAxisBuilder instance.

Categories(System.Object[])

The category names. Applicable for charts with X and Y category axes (heatmap).

Parameters

value - `System.Object[]`

The value for Categories

RETURNS

Returns the current ChartYAxisBuilder instance.

Color(System.String)

The color of the axis. Accepts a valid CSS color string, including hex and rgb.

Parameters

value - `System.String`

The value for Color

RETURNS

Returns the current ChartYAxisBuilder instance.

Crosshair(System.Action)

The crosshair configuration options.

Parameters

configurator - System.Action<ChartYAxisCrosshairSettingsBuilder>

The configurator for the crosshair setting.

RETURNS

Returns the current instance of ChartYAxisBuilder .

Labels(System.Action)

The axis labels configuration.

Parameters

configurator - System.Action<ChartYAxisLabelsSettingsBuilder>

The configurator for the labels setting.

RETURNS

Returns the current instance of ChartYAxisBuilder .

Line(System.Action)

The configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.

Parameters

configurator - System.Action<ChartYAxisLineSettingsBuilder>

The configurator for the line setting.

RETURNS

Returns the current instance of ChartYAxisBuilder .

MajorGridLines(System.Action)

The configuration of the major grid lines. These are the lines that are an extension of the major ticks through the body of the chart.

Parameters

configurator - System.Action<ChartYAxisMajorGridLinesSettingsBuilder>

The configurator for the majorgridlines setting.

RETURNS

Returns the current instance of ChartYAxisBuilder .

MinorGridLines(System.Action)

The configuration of the minor grid lines. These are the lines that are an extension of the minor ticks through the body of the chart.

Parameters

configurator - System.Action<ChartYAxisMinorGridLinesSettingsBuilder>

The configurator for the minorgridlines setting.

RETURNS

Returns the current instance of ChartYAxisBuilder .

MinorTicks(System.Action)

The configuration of the y axis minor ticks.

Parameters

configurator - System.Action<ChartYAxisMinorTicksSettingsBuilder>

The configurator for the minorticks setting.

RETURNS

Returns the current instance of ChartYAxisBuilder .

MajorTicks(System.Action)

The configuration of the scatter chart y axis major ticks.

Parameters

configurator - System.Action<ChartYAxisMajorTicksSettingsBuilder>

The configurator for the majorticks setting.

RETURNS

Returns the current instance of ChartYAxisBuilder .

MajorUnit(System.Double)

The interval between major divisions. If this is a date axis the value represents the number of xAxis.baseUnits between major divisions. If the yAxis.type is set to "log", the majorUnit value will be used for the base of the logarithm.

Parameters

value - `System.Double`

The value for MajorUnit

RETURNS

Returns the current ChartYAxisBuilder instance.

Max(System.Object)

The maximum value of the axis.

Parameters

value - `System.Object`

The value for Max

RETURNS

Returns the current ChartYAxisBuilder instance.

Min(System.Object)

The minimum value of the axis.

Parameters

value - `System.Object`

The value for Min

RETURNS

Returns the current ChartYAxisBuilder instance.

MinorUnit(System.Double)

The interval between minor divisions. It defaults to 1/5 of the yAxis.majorUnit. If the yAxis.type is set to "log", the minorUnit value represents the number of divisions between two major units and defaults to the major unit minus one.

Parameters

value - `System.Double`

The value for MinorUnit

RETURNS

Returns the current ChartYAxisBuilder instance.

Name(System.String)

The unique axis name. Used to associate a series with a y axis using the series.yAxis option.

Parameters

value - `System.String`

The value for Name

RETURNS

Returns the current ChartYAxisBuilder instance.

NarrowRange(System.Boolean)

If set to true the chart will prevent the automatic axis range from snapping to 0. Setting it to false will force the automatic axis range to snap to 0.

Parameters

value - `System.Boolean`

The value for NarrowRange

RETURNS

Returns the current ChartYAxisBuilder instance.

NarrowRange()

If set to true the chart will prevent the automatic axis range from snapping to 0. Setting it to false will force the automatic axis range to snap to 0.

RETURNS

Returns the current ChartYAxisBuilder instance.

Pane(System.String)

The name of the pane that the axis should be rendered in. The axis will be rendered in the first (default) pane if not set.

Parameters

value - `System.String`

The value for Pane

RETURNS

Returns the current ChartYAxisBuilder instance.

PlotBands(System.Action)

The plot bands of the y axis.

Parameters

configurator - System.Action<ChartYAxisPlotBandFactory>

The configurator for the plotbands setting.

RETURNS

Returns the current instance of ChartYAxisBuilder .

Reverse(System.Boolean)

If set to true the value axis direction will be reversed. By default values increase from left to right and from bottom to top.

Parameters

value - `System.Boolean`

The value for Reverse

RETURNS

Returns the current ChartYAxisBuilder instance.

Reverse()

If set to true the value axis direction will be reversed. By default values increase from left to right and from bottom to top.

RETURNS

Returns the current ChartYAxisBuilder instance.

Title(System.Action)

The title configuration of the scatter chart y axis.

Parameters

configurator - System.Action<ChartYAxisTitleSettingsBuilder>

The configurator for the title setting.

RETURNS

Returns the current instance of ChartYAxisBuilder .

Type(System.String)

The axis type.The supported values are: "numeric" - numeric axis.; "date" - specialized axis for displaying chronological data. or "log" - logarithmic axis..