Modifier and Type | Interface and Description |
---|---|
static class |
ChartParallelAxesLabelsOptions.Align |
static class |
ChartParallelAxesLabelsOptions.Overflow |
static class |
ChartParallelAxesLabelsOptions.Position3d |
Modifier and Type | Method and Description |
---|---|
ChartParallelAxesLabelsOptions.Align |
getAlign()
(Highcharts) What part of the string the given position is anchored to.
|
double[] |
getAutoRotation()
(Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
of label rotation to prevent overlapping labels.
|
double |
getAutoRotationLimit()
(Highcharts, Gantt) When each category width is more than this many
pixels, we don't apply auto rotation.
|
double |
getDistance()
(Highcharts) Angular gauges and solid gauges only.
|
boolean |
getEnabled()
(Highcharts) Enable or disable the axis labels.
|
String |
getFormat()
(Highcharts) A format string for the axis label.
|
FormatterCallbackFunction<AxisLabelsFormatterContextObject> |
getFormatter()
(Highcharts) Callback JavaScript function to format the label.
|
double |
getIndentation()
(Gantt) The number of pixels to indent the labels per level in a treegrid
axis.
|
Array<ChartParallelAxesLabelsLevelsOptions> |
getLevels()
(Gantt) Set options on specific levels in a tree grid axis.
|
double |
getMaxStaggerLines()
(Highcharts) Horizontal axis only.
|
ChartParallelAxesLabelsOptions.Overflow |
getOverflow()
(Highcharts) How to handle overflowing labels on horizontal axis.
|
double |
getPadding()
(Highcharts, Gantt) The pixel padding for axis labels, to ensure white
space between them.
|
ChartParallelAxesLabelsOptions.Position3d |
getPosition3d()
(Highcharts) Defines how the labels are be repositioned according to the
3D chart orientation.
|
boolean |
getReserveSpace()
(Highcharts, Gantt) Whether to reserve space for the labels.
|
double |
getRotation()
(Highcharts) Rotation of the labels in degrees.
|
boolean |
getSkew3d()
(Highcharts) If enabled, the axis labels will skewed to follow the
perspective.
|
double |
getStaggerLines()
(Highcharts) Horizontal axes only.
|
double |
getStep()
(Highcharts) To show only every n'th label on the axis, set the step to
n.
|
CSSObject |
getStyle()
(Highcharts) CSS styles for the label.
|
ChartParallelAxesLabelsSymbolOptions |
getSymbol()
(Gantt) The symbol for the collapse and expand icon in a treegrid.
|
boolean |
getUseHTML()
(Highcharts) Whether to use HTML to render the labels.
|
double |
getX()
(Highcharts) The x position offset of the label relative to the tick
position on the axis.
|
double |
getY()
(Highcharts) The y position offset of the label relative to the tick
position on the axis.
|
double |
getZIndex()
(Highcharts) The Z index for the axis labels.
|
void |
setAlign(ChartParallelAxesLabelsOptions.Align value)
(Highcharts) What part of the string the given position is anchored to.
|
void |
setAutoRotation(double[] value)
(Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
of label rotation to prevent overlapping labels.
|
void |
setAutoRotationLimit(double value)
(Highcharts, Gantt) When each category width is more than this many
pixels, we don't apply auto rotation.
|
void |
setDistance(double value)
(Highcharts) Angular gauges and solid gauges only.
|
void |
setEnabled(boolean value)
(Highcharts) Enable or disable the axis labels.
|
void |
setFormat(String value)
(Highcharts) A format string for the axis label.
|
void |
setFormatter(FormatterCallbackFunction<AxisLabelsFormatterContextObject> value)
(Highcharts) Callback JavaScript function to format the label.
|
void |
setIndentation(double value)
(Gantt) The number of pixels to indent the labels per level in a treegrid
axis.
|
void |
setLevels(Array<ChartParallelAxesLabelsLevelsOptions> value)
(Gantt) Set options on specific levels in a tree grid axis.
|
void |
setMaxStaggerLines(double value)
(Highcharts) Horizontal axis only.
|
void |
setOverflow(ChartParallelAxesLabelsOptions.Overflow value)
(Highcharts) How to handle overflowing labels on horizontal axis.
|
void |
setPadding(double value)
(Highcharts, Gantt) The pixel padding for axis labels, to ensure white
space between them.
|
void |
setPosition3d(ChartParallelAxesLabelsOptions.Position3d value)
(Highcharts) Defines how the labels are be repositioned according to the
3D chart orientation.
|
void |
setReserveSpace(boolean value)
(Highcharts, Gantt) Whether to reserve space for the labels.
|
void |
setRotation(double value)
(Highcharts) Rotation of the labels in degrees.
|
void |
setSkew3d(boolean value)
(Highcharts) If enabled, the axis labels will skewed to follow the
perspective.
|
void |
setStaggerLines(double value)
(Highcharts) Horizontal axes only.
|
void |
setStep(double value)
(Highcharts) To show only every n'th label on the axis, set the step to
n.
|
void |
setStyle(CSSObject value)
(Highcharts) CSS styles for the label.
|
void |
setSymbol(ChartParallelAxesLabelsSymbolOptions value)
(Gantt) The symbol for the collapse and expand icon in a treegrid.
|
void |
setUseHTML(boolean value)
(Highcharts) Whether to use HTML to render the labels.
|
void |
setX(double value)
(Highcharts) The x position offset of the label relative to the tick
position on the axis.
|
void |
setY(double value)
(Highcharts) The y position offset of the label relative to the tick
position on the axis.
|
void |
setZIndex(double value)
(Highcharts) The Z index for the axis labels.
|
@Nullable ChartParallelAxesLabelsOptions.Align getAlign()
"left"
, "center"
or "right"
. The exact position also
depends on the labels.x
setting.
Angular gauges and solid gauges defaults to center
.void setAlign(ChartParallelAxesLabelsOptions.Align value)
"left"
, "center"
or "right"
. The exact position also
depends on the labels.x
setting.
Angular gauges and solid gauges defaults to center
.@Nullable double[] getAutoRotation()
false
to disable
rotation, which will cause the labels to word-wrap if possible.void setAutoRotation(double[] value)
false
to disable
rotation, which will cause the labels to word-wrap if possible.double getAutoRotationLimit()
void setAutoRotationLimit(double value)
double getDistance()
void setDistance(double value)
boolean getEnabled()
void setEnabled(boolean value)
void setFormat(String value)
@Nullable FormatterCallbackFunction<AxisLabelsFormatterContextObject> getFormatter()
this.value
. Additional properties for this
are axis
,
chart
, isFirst
and isLast
. The value of the default label formatter
can be retrieved by calling this.axis.defaultLabelFormatter.call(this)
within the function.
Defaults to:
(see online documentation for example)void setFormatter(FormatterCallbackFunction<AxisLabelsFormatterContextObject> value)
this.value
. Additional properties for this
are axis
,
chart
, isFirst
and isLast
. The value of the default label formatter
can be retrieved by calling this.axis.defaultLabelFormatter.call(this)
within the function.
Defaults to:
(see online documentation for example)double getIndentation()
void setIndentation(double value)
@Nullable Array<ChartParallelAxesLabelsLevelsOptions> getLevels()
void setLevels(Array<ChartParallelAxesLabelsLevelsOptions> value)
double getMaxStaggerLines()
staggerLines
is not set,
maxStaggerLines
defines how many lines the axis is allowed to add to
automatically avoid overlapping X labels. Set to 1
to disable overlap
detection.void setMaxStaggerLines(double value)
staggerLines
is not set,
maxStaggerLines
defines how many lines the axis is allowed to add to
automatically avoid overlapping X labels. Set to 1
to disable overlap
detection.@Nullable ChartParallelAxesLabelsOptions.Overflow getOverflow()
"allow"
, it will not be aligned at all. By default it "justify"
labels inside the chart area. If there is room to move it, it will be
aligned to the edge, else it will be removed.void setOverflow(ChartParallelAxesLabelsOptions.Overflow value)
"allow"
, it will not be aligned at all. By default it "justify"
labels inside the chart area. If there is room to move it, it will be
aligned to the edge, else it will be removed.double getPadding()
void setPadding(double value)
@Nullable ChartParallelAxesLabelsOptions.Position3d getPosition3d()
'offset'
: Maintain a fixed horizontal/vertical distance from the tick
marks, despite the chart orientation. This is the backwards compatible
behavior, and causes skewing of X and Z axes.
'chart'
: Preserve 3D position relative to the chart. This looks nice,
but hard to read if the text isn't forward-facing.
'flap'
: Rotated text along the axis to compensate for the chart
orientation. This tries to maintain text as legible as possible on all
orientations.
'ortho'
: Rotated text along the axis direction so that the labels are
orthogonal to the axis. This is very similar to 'flap'
, but prevents
skewing the labels (X and Y scaling are still present).
void setPosition3d(ChartParallelAxesLabelsOptions.Position3d value)
'offset'
: Maintain a fixed horizontal/vertical distance from the tick
marks, despite the chart orientation. This is the backwards compatible
behavior, and causes skewing of X and Z axes.
'chart'
: Preserve 3D position relative to the chart. This looks nice,
but hard to read if the text isn't forward-facing.
'flap'
: Rotated text along the axis to compensate for the chart
orientation. This tries to maintain text as legible as possible on all
orientations.
'ortho'
: Rotated text along the axis direction so that the labels are
orthogonal to the axis. This is very similar to 'flap'
, but prevents
skewing the labels (X and Y scaling are still present).
boolean getReserveSpace()
label.align
is right
on a left-side axis or
left
on a right-side axis.
label.align
is center
.
void setReserveSpace(boolean value)
label.align
is right
on a left-side axis or
left
on a right-side axis.
label.align
is center
.
double getRotation()
void setRotation(double value)
boolean getSkew3d()
labels.position3d
.void setSkew3d(boolean value)
labels.position3d
.double getStaggerLines()
void setStaggerLines(double value)
double getStep()
void setStep(double value)
@Nullable CSSObject getStyle()
whiteSpace: 'nowrap'
to
prevent wrapping of category labels. Use textOverflow: 'none'
to
prevent ellipsis (dots).
In styled mode, the labels are styled with the .highcharts-axis-labels
class.void setStyle(CSSObject value)
whiteSpace: 'nowrap'
to
prevent wrapping of category labels. Use textOverflow: 'none'
to
prevent ellipsis (dots).
In styled mode, the labels are styled with the .highcharts-axis-labels
class.@Nullable ChartParallelAxesLabelsSymbolOptions getSymbol()
void setSymbol(ChartParallelAxesLabelsSymbolOptions value)
boolean getUseHTML()
void setUseHTML(boolean value)
double getX()
void setX(double value)
double getY()
void setY(double value)
double getZIndex()
void setZIndex(double value)
Copyright © 2020. All rights reserved.