Modifier and Type | Interface and Description |
---|---|
static class |
NavigatorXAxisTitleOptions.Align |
static class |
NavigatorXAxisTitleOptions.Position3d |
Modifier and Type | Method and Description |
---|---|
NavigatorXAxisTitleOptions.Align |
getAlign()
(Highstock) Alignment of the title relative to the axis values.
|
String |
getEnabled()
(Highcharts) Deprecated.
|
double |
getMargin()
(Highstock) The pixel distance between the axis labels or line and the
title.
|
double |
getOffset()
(Highstock) The distance of the axis title from the axis line.
|
NavigatorXAxisTitleOptions.Position3d |
getPosition3d()
(Highcharts) Defines how the title is repositioned according to the 3D
chart orientation.
|
boolean |
getReserveSpace()
(Highcharts, Highstock, Gantt) Whether to reserve space for the title
when laying out the axis.
|
double |
getRotation()
(Highstock) The rotation of the text in degrees.
|
boolean |
getSkew3d()
(Highcharts) If enabled, the axis title will skewed to follow the
perspective.
|
CSSObject |
getStyle()
(Highstock) CSS styles for the title.
|
String |
getText()
(Highstock) The actual text of the axis title.
|
String |
getTextAlign()
(Highstock) Alignment of the text, can be
"left" , "right" or
"center" . |
boolean |
getUseHTML()
(Highcharts, Highstock, Gantt) Whether to use HTML to render the axis
title.
|
double |
getX()
(Highcharts, Highstock, Gantt) Horizontal pixel offset of the title
position.
|
double |
getY()
(Highcharts, Highstock, Gantt) Vertical pixel offset of the title
position.
|
void |
setAlign(NavigatorXAxisTitleOptions.Align value)
(Highstock) Alignment of the title relative to the axis values.
|
void |
setEnabled(String value)
(Highcharts) Deprecated.
|
void |
setMargin(double value)
(Highstock) The pixel distance between the axis labels or line and the
title.
|
void |
setOffset(double value)
(Highstock) The distance of the axis title from the axis line.
|
void |
setPosition3d(NavigatorXAxisTitleOptions.Position3d value)
(Highcharts) Defines how the title is repositioned according to the 3D
chart orientation.
|
void |
setReserveSpace(boolean value)
(Highcharts, Highstock, Gantt) Whether to reserve space for the title
when laying out the axis.
|
void |
setRotation(double value)
(Highstock) The rotation of the text in degrees.
|
void |
setSkew3d(boolean value)
(Highcharts) If enabled, the axis title will skewed to follow the
perspective.
|
void |
setStyle(CSSObject value)
(Highstock) CSS styles for the title.
|
void |
setText(String value)
(Highstock) The actual text of the axis title.
|
void |
setTextAlign(String value)
(Highstock) Alignment of the text, can be
"left" , "right" or
"center" . |
void |
setUseHTML(boolean value)
(Highcharts, Highstock, Gantt) Whether to use HTML to render the axis
title.
|
void |
setX(double value)
(Highcharts, Highstock, Gantt) Horizontal pixel offset of the title
position.
|
void |
setY(double value)
(Highcharts, Highstock, Gantt) Vertical pixel offset of the title
position.
|
@Nullable NavigatorXAxisTitleOptions.Align getAlign()
void setAlign(NavigatorXAxisTitleOptions.Align value)
@Nullable String getEnabled()
text
to null
to disable the title.void setEnabled(String value)
text
to null
to disable the title.double getMargin()
void setMargin(double value)
double getOffset()
void setOffset(double value)
@Nullable NavigatorXAxisTitleOptions.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).
undefined
: Will use the config from labels.position3d
void setPosition3d(NavigatorXAxisTitleOptions.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).
undefined
: Will use the config from labels.position3d
boolean getReserveSpace()
void setReserveSpace(boolean value)
double getRotation()
void setRotation(double value)
boolean getSkew3d()
title.position3d
.
A null
value will use the config from labels.skew3d
.void setSkew3d(boolean value)
title.position3d
.
A null
value will use the config from labels.skew3d
.@Nullable CSSObject getStyle()
textOverflow: 'ellipsis'
, by setting a specific
width
or by setting whiteSpace: 'nowrap'
.
In styled mode, the stroke width is given in the .highcharts-axis-title
class.void setStyle(CSSObject value)
textOverflow: 'ellipsis'
, by setting a specific
width
or by setting whiteSpace: 'nowrap'
.
In styled mode, the stroke width is given in the .highcharts-axis-title
class.@Nullable String getText()
void setText(String value)
@Nullable String getTextAlign()
"left"
, "right"
or
"center"
. Default alignment depends on the title.align:
Horizontal axes:
align
= "low"
, textAlign
is set to left
align
= "middle"
, textAlign
is set to center
align
= "high"
, textAlign
is set to right
align
= "low"
and opposite
= true
, textAlign
is set to
right
align
= "low"
and opposite
= false
, textAlign
is set to
left
align
= "middle"
, textAlign
is set to center
align
= "high"
and opposite
= true
textAlign
is set to
left
align
= "high"
and opposite
= false
textAlign
is set to
right
void setTextAlign(String value)
"left"
, "right"
or
"center"
. Default alignment depends on the title.align:
Horizontal axes:
align
= "low"
, textAlign
is set to left
align
= "middle"
, textAlign
is set to center
align
= "high"
, textAlign
is set to right
align
= "low"
and opposite
= true
, textAlign
is set to
right
align
= "low"
and opposite
= false
, textAlign
is set to
left
align
= "middle"
, textAlign
is set to center
align
= "high"
and opposite
= true
textAlign
is set to
left
align
= "high"
and opposite
= false
textAlign
is set to
right
boolean getUseHTML()
void setUseHTML(boolean value)
double getX()
void setX(double value)
double getY()
void setY(double value)
Copyright © 2020. All rights reserved.