io.udash.wrappers.highcharts.config.axis
ColorAxis
Related Docs:
object ColorAxis
| package axis
A class name that opens for styling the axis by CSS, especially in Highcharts styled mode.
A class name that opens for styling the axis by CSS, especially in Highcharts styled mode. The class name is applied to group elements for the grid, axis elements and labels.
Determines how to set each data class' color if no individual color is set.
Determines how to set each data class' color if no individual color is set. The default value, tween,
computes intermediate colors between minColor and maxColor.
The other possible value, category, pulls colors from the global or chart specific colors array.
An array of data classes or ranges for the choropleth map.
An array of data classes or ranges for the choropleth map. If none given, the color axis is scalar and values are distributed as a gradient between the minimum and maximum colors.
Whether to force the axis to end on a tick.
Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end.
Event handlers for the axis.
Event handlers for the axis.
Color of the grid lines extending from the axis across the gradient.
Color of the grid lines extending from the axis across the gradient.
The dash or dot style of the grid lines.
The dash or dot style of the grid lines. For possible values, see this demonstration.
The width of the grid lines extending from the axis across the gradient of a scalar color axis.
The width of the grid lines extending from the axis across the gradient of a scalar color axis.
An id for the axis.
An id for the axis. This can be used after render time to get a pointer to the axis object through chart.get().
The axis labels show the number for each tick.
The axis labels show the number for each tick.
For more live examples on label options, see xAxis.labels in the Highcharts API.
The color of the line marking the axis itself.
The color of the line marking the axis itself.
The width of the line marking the axis itself.
The width of the line marking the axis itself.
The triangular marker on a scalar color axis that points to the value of the hovered area.
The triangular marker on a scalar color axis that points to the value of the hovered area. To disable the marker, set marker: null.
The maximum value of the axis in terms of map point values.
The maximum value of the axis in terms of map point values. If null, the max value is automatically calculated.
If the endOnTick option is true, the max value might be rounded up.
The color to represent the maximum of the color axis.
The color to represent the maximum of the color axis. Unless dataClasses or stops are set, the gradient ends at this value.
If dataClasses are set, the color is based on minColor and maxColor unless a color is set for each data class, or the dataClassColor is set.
Padding of the max value relative to the length of the axis.
Padding of the max value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
The minimum value of the axis.
The minimum value of the axis. If null the min value is automatically calculated.
If the startOnTick option is true, the min value might be rounded down.
The color to represent the minimum of the color axis.
The color to represent the minimum of the color axis. Unless dataClasses or stops are set, the gradient starts at this value.
If dataClasses are set, the color is based on minColor and maxColor unless a color is set for each data class, or the dataClassColor is set.
Padding of the min value relative to the length of the axis.
Padding of the min value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
This is useful when you don't want the lowest data value to appear on the edge of the plot area.
When the axis' min option is set or a min extreme is set using axis.setExtremes(),
the minPadding will be ignored.
The minimum tick interval allowed in axis values.
The minimum tick interval allowed in axis values. For example on zooming in on an axis with daily data, this can be used to prevent the axis from showing hours. Defaults to the closest distance between two points on the axis.
Color of the minor, secondary grid lines.
Color of the minor, secondary grid lines.
The dash or dot style of the minor grid lines.
The dash or dot style of the minor grid lines. For possible values, see this demonstration.
Width of the minor, secondary grid lines.
Width of the minor, secondary grid lines.
Color for the minor tick marks.
Color for the minor tick marks.
Tick interval in scale units for the minor ticks.
Tick interval in scale units for the minor ticks. On a linear axis, if "auto",
the minor tick interval is calculated as a fifth of the tickInterval. If
null, minor ticks are not shown.
On logarithmic axes, the unit is the power of the value. For example, setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 10, 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks between 1 and 10, 10 and 100 etc. A minorTickInterval of "auto" on a log axis results in a best guess, attempting to enter approximately 5 minor ticks between each major tick.
If user settings dictate minor ticks to become too dense, they don't make sense, and will be ignored to prevent performance problems.
On axes using categories, minor ticks are not supported.
Null by default,"auto" on linear Y axis,5 units on linear Y axis,"auto" on logarithmic Y axis,0.1 on logarithmic Y axis.
The pixel length of the minor tick marks.
The pixel length of the minor tick marks.
The position of the minor tick marks relative to the axis line.
The position of the minor tick marks relative to the axis line. Can be one of inside and outside.
The pixel width of the minor tick mark.
Whether to reverse the axis so that the highest number is closest to the origin.
Whether to reverse the axis so that the highest number is closest to the origin. If the chart is inverted, the x axis is reversed by default.
Whether to show the first tick label.
Whether to show the first tick label.
Whether to show the last tick label.
Whether to show the last tick label.
Whether to force the axis to start on a tick.
Whether to force the axis to start on a tick. Use this option with the maxPadding option to control the axis start.
Color stops for the gradient of a scalar color axis.
Color stops for the gradient of a scalar color axis. Use this in cases where a linear gradient between
a minColor and maxColor is not sufficient. The stops is an array of tuples,
where the first item is a float between 0 and 1 assigning the relative position in the gradient, and the second item is the color.
Color for the main tick marks.
Color for the main tick marks.
The interval of the tick marks in axis units.
The interval of the tick marks in axis units. When null, the tick interval
is computed to approximately follow the tickPixelInterval on linear and datetime axes.
On categorized axes, a null tickInterval will default to 1, one category.
Note that datetime axes are based on milliseconds, so for
example an interval of one day is expressed as 24 * 3600 * 1000.
On logarithmic axes, the tickInterval is based on powers, so a tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval of 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 40 etc.
If the tickInterval is too dense for labels to be drawn, Highcharts may remove ticks.
If the chart has multiple axes, the alignTicks option may interfere with the tickInterval setting.
The pixel length of the main tick marks.
The pixel length of the main tick marks.
If tickInterval is null this option sets the approximate pixel interval of the
tick marks.
If tickInterval is null this option sets the approximate pixel interval of the
tick marks. Not applicable to categorized axis. Defaults to 72
for the Y axis and 100 for the X axis.
The position of the major tick marks relative to the axis line.
The position of the major tick marks relative to the axis line. Can be one of insideand outside.
"outside" by default,"inside" on X axis
A callback function returning array defining where the ticks are laid out on the axis.
A callback function returning array defining where the ticks are laid out on the axis.
This overrides the default behaviour of tickPixelInterval and tickInterval.
An array defining where the ticks are laid out on the axis.
An array defining where the ticks are laid out on the axis. This overrides the default
behaviour of tickPixelInterval and tickInterval.
The pixel width of the major tick marks.
The pixel width of the major tick marks.
The type of axis.
The type of axis. Can be one of linear, logarithmic, datetime or category. In a datetime axis, the numbers are given in milliseconds, and tick marks are placed on appropriate values like full hours or days. In a category axis, the point names of the chart's series are used for categories, if not a categories array is defined.