object ColorAxis
- Alphabetic
- By Inheritance
- ColorAxis
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
-
def
apply(className: UndefOr[String] = js.undefined, dataClassColor: UndefOr[String] = js.undefined, dataClasses: UndefOr[Array[CleanJsObject[ColorAxisDataClasses]]] = js.undefined, description: UndefOr[String] = js.undefined, endOnTick: UndefOr[Boolean] = js.undefined, events: UndefOr[CleanJsObject[ColorAxisEvents]] = js.undefined, gridLineColor: UndefOr[|[String, Object]] = js.undefined, gridLineDashStyle: UndefOr[String] = js.undefined, gridLineWidth: UndefOr[Double] = js.undefined, id: UndefOr[String] = js.undefined, labels: UndefOr[CleanJsObject[ColorAxisLabels]] = js.undefined, lineColor: UndefOr[|[String, Object]] = js.undefined, lineWidth: UndefOr[Double] = js.undefined, marker: UndefOr[CleanJsObject[ColorAxisMarker]] = js.undefined, max: UndefOr[Double] = js.undefined, maxColor: UndefOr[|[String, Object]] = js.undefined, maxPadding: UndefOr[Double] = js.undefined, min: UndefOr[Double] = js.undefined, minColor: UndefOr[|[String, Object]] = js.undefined, minPadding: UndefOr[Double] = js.undefined, minorGridLineColor: UndefOr[|[String, Object]] = js.undefined, minorGridLineDashStyle: UndefOr[String] = js.undefined, minorGridLineWidth: UndefOr[Double] = js.undefined, minorTickColor: UndefOr[|[String, Object]] = js.undefined, minorTickInterval: UndefOr[|[String, Double]] = js.undefined, minorTickLength: UndefOr[Double] = js.undefined, minorTickPosition: UndefOr[String] = js.undefined, minorTickWidth: UndefOr[Double] = js.undefined, reversed: UndefOr[Boolean] = js.undefined, showFirstLabel: UndefOr[Boolean] = js.undefined, showInLegend: UndefOr[Boolean] = js.undefined, showLastLabel: UndefOr[Boolean] = js.undefined, softMin: UndefOr[Double] = js.undefined, startOnTick: UndefOr[Boolean] = js.undefined, stops: UndefOr[Array[Array[Any]]] = js.undefined, tickColor: UndefOr[|[String, Object]] = js.undefined, tickInterval: UndefOr[Double] = js.undefined, tickLength: UndefOr[Double] = js.undefined, tickPixelInterval: UndefOr[Double] = js.undefined, tickPosition: UndefOr[String] = js.undefined, tickPositioner: UndefOr[Function] = js.undefined, tickPositions: UndefOr[Array[Double]] = js.undefined, tickWidth: UndefOr[Double] = js.undefined, type: UndefOr[String] = js.undefined): ColorAxis
- className
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.
- dataClassColor
Determines how to set each data class' color if no individual color is set. The default value,
tween, computes intermediate colors betweenminColorandmaxColor. The other possible value,category, pulls colors from the global or chart specific colors array.- dataClasses
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.
- description
Requires Accessibility module. . Description of the axis to screen reader users.
- endOnTick
Whether to force the axis to end on a tick. Use this option with the maxPadding option to control the axis end.
- events
Event handlers for the axis.
- gridLineColor
Color of the grid lines extending from the axis across the gradient.
- gridLineDashStyle
The dash or dot style of the grid lines. For possible values, see this demonstration.
- gridLineWidth
The width of the grid lines extending from the axis across the gradient of a scalar color axis.
- id
An id for the axis. This can be used after render time to get a pointer to the axis object through
chart.get().- labels
The axis labels show the number for each tick.. For more live examples on label options, see xAxis.labels in the Highcharts API.
- lineColor
The color of the line marking the axis itself.
- lineWidth
The width of the line marking the axis itself.. . In styled mode, the stroke width is given in the
.highcharts-axis-lineor.highcharts-xaxis-lineclass.- marker
The triangular marker on a scalar color axis that points to the value of the hovered area. To disable the marker, set
marker: null.- max
The maximum value of the axis in terms of map point values. If
null, the max value is automatically calculated. If theendOnTickoption is true, the max value might be rounded up.- maxColor
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.
- maxPadding
Padding of the max value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
- min
The minimum value of the axis in terms of map point values. If
null, the min value is automatically calculated. If thestartOnTickoption is true, the min value might be rounded down.- minColor
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.
- minPadding
Padding of the min value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer.
- minorGridLineColor
Color of the minor, secondary grid lines.
- minorGridLineDashStyle
The dash or dot style of the minor grid lines. For possible values, see this demonstration.
- minorGridLineWidth
Width of the minor, secondary grid lines.
- minorTickColor
Color for the minor tick marks.
- minorTickInterval
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.- minorTickLength
The pixel length of the minor tick marks.
- minorTickPosition
The position of the minor tick marks relative to the axis line. Can be one of
insideandoutside.- minorTickWidth
The pixel width of the minor tick mark.
- reversed
Whether to reverse the axis so that the highest number is closest to the origin. Defaults to
falsein a horizontal legend andtruein a vertical legend, where the smallest value starts on top.- showFirstLabel
If labels are enabled, whether to show the first tick label.
- showInLegend
Whether to display the colorAxis in the legend.
- showLastLabel
If labels are enabled, whether to show the last tick label.
- softMin
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.
- startOnTick
Whether to force the axis to start on a tick. Use this option with the
maxPaddingoption to control the axis start.- stops
Color stops for the gradient of a scalar color axis. Use this in cases where a linear gradient between a
minColorandmaxColoris 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.- tickColor
Color for the main tick marks.
- tickInterval
The interval of the tick marks in axis units. When
null, the tick interval is computed to approximately follow thetickPixelInterval.- tickLength
The pixel length of the main tick marks.
- tickPixelInterval
If tickInterval is
nullthis option sets the approximate pixel interval of the tick marks.- tickPosition
The position of the major tick marks relative to the axis line. Can be one of
insideandoutside.- tickPositioner
A callback function returning array defining where the ticks are laid out on the axis. This overrides the default behaviour of
tickPixelIntervalandtickInterval.- tickPositions
An array defining where the ticks are laid out on the axis. This overrides the default behaviour of
tickPixelIntervalandtickInterval.- tickWidth
The pixel width of the major tick marks.. . In styled mode, the stroke width is given in the
.highcharts-tickclass.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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( ... )