ColorAxis

Instance Constructors

new ColorAxis()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val className: UndefOr[String]

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.
Example:
1. Multiple axes with separate styling.
Since
5.0.0
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dataClassColor: UndefOr[String]

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.
Example:
1. Category colors
val dataClasses: UndefOr[Array[CleanJsObject[ColorAxisDataClasses]]]

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.
Example:
1. Multiple ranges, two ranges.
val description: UndefOr[String]

Requires Accessibility module
Requires Accessibility module
Description of the axis to screen reader users.
Example:
1. Accessible complex chart
Since
5.0.0
val endOnTick: UndefOr[Boolean]

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.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val events: UndefOr[CleanJsObject[ColorAxisEvents]]

Event handlers for the axis.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val gridLineColor: UndefOr[|[String, Object]]

Color of the grid lines extending from the axis across the gradient.
Color of the grid lines extending from the axis across the gradient.
Example:
1. Grid lines demonstrated
val gridLineDashStyle: UndefOr[String]

The dash or dot style of the grid lines.
The dash or dot style of the grid lines. For possible values, see this demonstration.
val gridLineWidth: UndefOr[Double]

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.
Example:
1. Grid lines demonstrated
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
val id: UndefOr[String]

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().
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
val labels: UndefOr[CleanJsObject[ColorAxisLabels]]

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.
val lineColor: UndefOr[|[String, Object]]

The color of the line marking the axis itself.
val lineWidth: UndefOr[Double]

The width of the line marking the axis itself.
The width of the line marking the axis itself.
In styled mode, the stroke width is given in the .highcharts-axis-line or .highcharts-xaxis-line class.
val marker: UndefOr[CleanJsObject[ColorAxisMarker]]

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.
Example:
1. Black marker
val max: UndefOr[Double]

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.
Example:
1. Explicit min and max to reduce the effect of outliers
val maxColor: UndefOr[|[String, Object]]

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.
Example:
1. Min and max colors on scalar (gradient) axis, on data classes.
val maxPadding: UndefOr[Double]

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.
val min: UndefOr[Double]

The minimum value of the axis in terms of map point values.
The minimum value of the axis in terms of map point values. If null, the min value is automatically calculated. If the startOnTick option is true, the min value might be rounded down.
Example:
1. Explicit min and max to reduce the effect of outliers
val minColor: UndefOr[|[String, Object]]

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.
Example:
1. Min and max colors on scalar (gradient) axis, on data classes.
val minPadding: UndefOr[Double]

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.
val minorGridLineColor: UndefOr[|[String, Object]]

Color of the minor, secondary grid lines.
val minorGridLineDashStyle: UndefOr[String]

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.
val minorGridLineWidth: UndefOr[Double]

Width of the minor, secondary grid lines.
val minorTickColor: UndefOr[|[String, Object]]

Color for the minor tick marks.
val minorTickInterval: UndefOr[|[String, Double]]

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.
val minorTickLength: UndefOr[Double]

The pixel length of the minor tick marks.
val minorTickPosition: UndefOr[String]

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.
val minorTickWidth: UndefOr[Double]

The pixel width of the minor tick mark.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
val reversed: UndefOr[Boolean]

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. Defaults to false in a horizontal legend and true in a vertical legend, where the smallest value starts on top.
val showFirstLabel: UndefOr[Boolean]

If labels are enabled, whether to show the first tick label.
val showInLegend: UndefOr[Boolean]

Whether to display the colorAxis in the legend.
Whether to display the colorAxis in the legend.

Since
4.2.7
val showLastLabel: UndefOr[Boolean]

If labels are enabled, whether to show the last tick label.
val softMin: UndefOr[Double]

A soft minimum for the axis.
A soft minimum for the axis. If the series data minimum is greater than this, the axis will stay at this minimum, but if the series data minimum is lower, the axis will flex to show all data.
Example:
1. Soft min and max
Since
5.0.1
val startOnTick: UndefOr[Boolean]

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.
val stops: UndefOr[Array[Array[Any]]]

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.
Example:
1. Heatmap with three color stops
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tickColor: UndefOr[|[String, Object]]

Color for the main tick marks.
val tickInterval: UndefOr[Double]

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.
val tickLength: UndefOr[Double]

The pixel length of the main tick marks.
val tickPixelInterval: UndefOr[Double]

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.
val tickPosition: UndefOr[String]

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 inside and outside.
val tickPositioner: UndefOr[Function]

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.
val tickPositions: UndefOr[Array[Double]]

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.
val tickWidth: UndefOr[Double]

The pixel width of the major tick marks.
The pixel width of the major tick marks.
In styled mode, the stroke width is given in the .highcharts-tick class.
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val type: UndefOr[String]

The type of interpolation to use for the color axis.
The type of interpolation to use for the color axis. Can be linear or logarithmic.
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object ColorAxis | package config

class ColorAxis extends Object

Instance Constructors

new ColorAxis()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val className: UndefOr[String]

def clone(): AnyRef

val dataClassColor: UndefOr[String]

val dataClasses: UndefOr[Array[CleanJsObject[ColorAxisDataClasses]]]

val description: UndefOr[String]

val endOnTick: UndefOr[Boolean]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: UndefOr[CleanJsObject[ColorAxisEvents]]

def finalize(): Unit

final def getClass(): Class[_]

val gridLineColor: UndefOr[|[String, Object]]

val gridLineDashStyle: UndefOr[String]

val gridLineWidth: UndefOr[Double]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val id: UndefOr[String]

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val labels: UndefOr[CleanJsObject[ColorAxisLabels]]

val lineColor: UndefOr[|[String, Object]]

val lineWidth: UndefOr[Double]

val marker: UndefOr[CleanJsObject[ColorAxisMarker]]

val max: UndefOr[Double]

val maxColor: UndefOr[|[String, Object]]

val maxPadding: UndefOr[Double]

val min: UndefOr[Double]

val minColor: UndefOr[|[String, Object]]

val minPadding: UndefOr[Double]

val minorGridLineColor: UndefOr[|[String, Object]]

val minorGridLineDashStyle: UndefOr[String]

val minorGridLineWidth: UndefOr[Double]

val minorTickColor: UndefOr[|[String, Object]]

val minorTickInterval: UndefOr[|[String, Double]]

val minorTickLength: UndefOr[Double]

val minorTickPosition: UndefOr[String]

val minorTickWidth: UndefOr[Double]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def propertyIsEnumerable(v: String): Boolean

val reversed: UndefOr[Boolean]

val showFirstLabel: UndefOr[Boolean]

val showInLegend: UndefOr[Boolean]

val showLastLabel: UndefOr[Boolean]

val softMin: UndefOr[Double]

val startOnTick: UndefOr[Boolean]

val stops: UndefOr[Array[Array[Any]]]

final def synchronized[T0](arg0: ⇒ T0): T0

val tickColor: UndefOr[|[String, Object]]

val tickInterval: UndefOr[Double]

val tickLength: UndefOr[Double]

val tickPixelInterval: UndefOr[Double]

val tickPosition: UndefOr[String]

val tickPositioner: UndefOr[Function]

val tickPositions: UndefOr[Array[Double]]

val tickWidth: UndefOr[Double]

def toLocaleString(): String

def toString(): String

val type: UndefOr[String]

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped