\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
A PHP class representing the categoryAxis setting of StockChartNavigator.
Methods
autoBaseUnitSteps
The discrete navigator.categoryAxis.baseUnitStep values when either navigator.categoryAxis.baseUnit is set to "fit" ornavigator.categoryAxis.baseUnitStep is set to "auto".
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisAutoBaseUnitSteps|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisAutoBaseUnitSteps
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$autoBaseUnitSteps = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisAutoBaseUnitSteps();
$days = array();
$autoBaseUnitSteps->days($days);
$categoryAxis->autoBaseUnitSteps($autoBaseUnitSteps);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$days = array();
$categoryAxis->autoBaseUnitSteps(array('days' => $days));
?>
axisCrossingValue
Category index at which the first value axis crosses this axis (when set as an object).Category indices at which the value axes cross the category axis (when set as an array).
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value |date|array
Example - using
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->axisCrossingValue(new ());
?>
Example - using date
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->axisCrossingValue(new date());
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->axisCrossingValue(array());
?>
background
The background color of the axis.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value string
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->background('value');
?>
baseUnit
The base time interval for the date axis. The default base unit is determined automatically from the minimum difference between subsequent categories.The supported values are: "fit"; "seconds"; "minutes"; "hours"; "days"; "weeks"; "months" or "years". Setting baseUnit to "fit" will set such base unit and categoryAxis.baseUnitStep that the total number of categories does not exceed categoryAxis.maxDateGroups.Series data is aggregated for the specified base unit using the series.aggregate function.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value string
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->baseUnit('value');
?>
baseUnitStep
The step (interval) between categories in base units. Setting it to "auto" will set the step to such value that the total number of categories does not exceed categoryAxis.maxDateGroups.This option is ignored if categoryAxis.baseUnit is set to "fit".
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value ``
categories
The category names. The chart will create a category for every item of the array.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value array
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->categories(array());
?>
color
The color to apply to all axis elements. Accepts a valid CSS color string, including hex and rgb. Can be overridden by categoryAxis.labels.color andcategoryAxis.line.color.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value string
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->color('value');
?>
crosshair
The crosshair configuration options.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisCrosshair|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisCrosshair
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$crosshair = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisCrosshair();
$color = 'value';
$crosshair->color($color);
$categoryAxis->crosshair($crosshair);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$color = 'value';
$categoryAxis->crosshair(array('color' => $color));
?>
field
The data item field which contains the category name. Requires the dataSource option to be set.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value string
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->field('value');
?>
justified
If set to true the chart will position categories and series points on major ticks. This removes the empty space before and after the series.The default value is false except for "area" and "verticalArea".
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value boolean
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->justified(true);
?>
labels
The axis labels configuration.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisLabels|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisLabels
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$labels = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisLabels();
$background = 'value';
$labels->background($background);
$categoryAxis->labels($labels);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$background = 'value';
$categoryAxis->labels(array('background' => $background));
?>
line
The configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisLine|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisLine
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$line = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisLine();
$color = 'value';
$line->color($color);
$categoryAxis->line($line);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$color = 'value';
$categoryAxis->line(array('color' => $color));
?>
majorGridLines
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.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMajorGridLines|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMajorGridLines
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$majorGridLines = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMajorGridLines();
$color = 'value';
$majorGridLines->color($color);
$categoryAxis->majorGridLines($majorGridLines);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$color = 'value';
$categoryAxis->majorGridLines(array('color' => $color));
?>
majorTicks
The configuration of the category axis major ticks.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMajorTicks|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMajorTicks
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$majorTicks = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMajorTicks();
$color = 'value';
$majorTicks->color($color);
$categoryAxis->majorTicks($majorTicks);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$color = 'value';
$categoryAxis->majorTicks(array('color' => $color));
?>
max
The last date displayed on the category date axis. By default, the minimum date is the same as the last category. This is often used in combination with the categoryAxis.min and categoryAxis.roundToBaseUnit options to set up a fixed date range.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value ``
maxDateGroups
The maximum number of groups (categories) to display whencategoryAxis.baseUnit is set to "fit" orcategoryAxis.baseUnitStep is set to "auto".
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value float
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->maxDateGroups(1);
?>
maxDivisions
The maximum number of ticks and labels to display.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value float
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->maxDivisions(1);
?>
min
The first date displayed on the category date axis. By default, the minimum date is the same as the first category. This is often used in combination with the categoryAxis.min and categoryAxis.roundToBaseUnit options to set up a fixed date range.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value ``
minorGridLines
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.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMinorGridLines|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMinorGridLines
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$minorGridLines = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMinorGridLines();
$color = 'value';
$minorGridLines->color($color);
$categoryAxis->minorGridLines($minorGridLines);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$color = 'value';
$categoryAxis->minorGridLines(array('color' => $color));
?>
minorTicks
The configuration of the category axis minor ticks.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMinorTicks|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMinorTicks
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$minorTicks = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisMinorTicks();
$color = 'value';
$minorTicks->color($color);
$categoryAxis->minorTicks($minorTicks);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$color = 'value';
$categoryAxis->minorTicks(array('color' => $color));
?>
notes
The category axis notes configuration.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisNotes|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisNotes
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$notes = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisNotes();
$position = 'value';
$notes->position($position);
$categoryAxis-<blockquote class='note'><p>s($notes);</p></blockquote>
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$position = 'value';
$categoryAxis-<blockquote class='note'><p>s(array('position' => $position));</p></blockquote>
?>
addPlotBand
Adds one or more StockChartNavigatorCategoryAxisPlotBand to the StockChartNavigatorCategoryAxis.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value[, $value2, ...] \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisPlotBand|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisPlotBand
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$plotBand = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisPlotBand();
$color = 'value';
$plotBand->color($color);
$categoryAxis->addPlotBand($plotBand);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$color = 'value';
$categoryAxis->addPlotBand(array('color' => $color));
?>
Example - adding more than one StockChartNavigatorCategoryAxisPlotBand
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$first = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisPlotBand();
$second = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisPlotBand();
$categoryAxis->addPlotBand($first, $second);
?>
reverse
If set to true the category axis direction will be reversed. By default categories are listed from left to right and from bottom to top.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value boolean
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->reverse(true);
?>
roundToBaseUnit
If set to true the chart will round the first and last date to the nearest base unit.The roundToBaseUnit option will be ignored if series.type is set to "bar", "column", "ohlc" or "candlestick".
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value boolean
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->roundToBaseUnit(true);
?>
title
The title configuration of the category axis.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisTitle|array
Example - using \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisTitle
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$title = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxisTitle();
$background = 'value';
$title->background($background);
$categoryAxis->title($title);
?>
Example - using array
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$background = 'value';
$categoryAxis->title(array('background' => $background));
?>
visible
If set to true the chart will display the category axis. By default the category axis is visible.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value boolean
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->visible(true);
?>
weekStartDay
The week start day when categoryAxis.baseUnit is set to "weeks".The supported values are: kendo.days.Sunday - equal to 0; kendo.days.Monday - equal to 1; kendo.days.Tuesday - equal to 2; kendo.days.Wednesday - equal to 3; kendo.days.Thursday - equal to 4; kendo.days.Friday - equal to 5 or kendo.days.Saturday - equal to 6.
Returns
\Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis
Parameters
$value float
Example
<?php
$categoryAxis = new \Kendo\Dataviz\UI\StockChartNavigatorCategoryAxis();
$categoryAxis->weekStartDay(1);
?>