class SeriesPyramidDataLabels extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
series<pyramid>-dataLabels
- Alphabetic
- By Inheritance
- SeriesPyramidDataLabels
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new SeriesPyramidDataLabels()
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
backgroundColor: UndefOr[|[String, Object]]
The background color or gradient for the data label.
The background color or gradient for the data label. Defaults to
undefined.- Since
2.2.1
Example: -
val
borderColor: UndefOr[|[String, Object]]
The border color for the data label.
The border color for the data label. Defaults to
undefined.- Since
2.2.1
Example: -
val
borderRadius: UndefOr[Double]
The border radius in pixels for the data label.
The border radius in pixels for the data label.
- Since
2.2.1
Example: -
val
borderWidth: UndefOr[Double]
The border width in pixels for the data label.
The border width in pixels for the data label.
- Since
2.2.1
Example: -
val
className: UndefOr[String]
A class name for the data label.
A class name for the data label. Particularly in styled mode, this can be used to give each series' or point's data label unique styling. In addition to this option, a default color class name is added so that we can give the labels a contrast text shadow.
- Since
5.0.0
Example: -
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
color: UndefOr[|[String, Object]]
The text color for the data labels.
The text color for the data labels. Defaults to
null.Example: -
val
connectorColor: UndefOr[String]
The color of the line connecting the data label to the pie slice.
The color of the line connecting the data label to the pie slice. The default color is the same as the point's color.
In styled mode, the connector stroke is given in the
.highcharts-data-label-connectorclass.- Since
2.1
Example: -
val
connectorPadding: UndefOr[Double]
The distance from the data label to the connector.
The distance from the data label to the connector.
- Since
2.1
Example: -
val
connectorWidth: UndefOr[Double]
The width of the line connecting the data label to the pie slice.
The width of the line connecting the data label to the pie slice.
In styled mode, the connector stroke width is given in the
.highcharts-data-label-connectorclass.- Since
2.1
Example: -
val
crop: UndefOr[Boolean]
Whether to hide data labels that are outside the plot area.
Whether to hide data labels that are outside the plot area. By default, the data label is moved inside the plot area according to the overflow option.
- Since
2.3.3
-
val
defer: UndefOr[Boolean]
Whether to defer displaying the data labels until the initial series animation has finished.
Whether to defer displaying the data labels until the initial series animation has finished.
- Since
4.0
-
val
distance: UndefOr[Double]
The distance of the data label from the pie's edge.
The distance of the data label from the pie's edge. Negative numbers put the data label on top of the pie slices. Connectors are only shown for data labels outside the pie.
- Since
2.1
Example: -
val
enabled: UndefOr[Boolean]
Enable or disable the data labels.
Enable or disable the data labels.
- Since
2.1
-
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] )
-
val
format: UndefOr[String]
A format string for the data label.
A format string for the data label. Available variables are the same as for
formatter.- Since
3.0
Example: -
val
formatter: UndefOr[Function]
Callback JavaScript function to format the data label.
Callback JavaScript function to format the data label. Note that if a
formatis defined, the format takes precedence and the formatter is ignored. Available data are:this.percentageStacked series and pies only. The point's percentage of the total. this.pointThe point object. The point name, if defined, is available through this.point.name.this.series:The series object. The series name is available through this.series.name.this.totalStacked series only. The total value at this point's x value. this.x:The x value. this.y:The y value. -
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
val
inside: UndefOr[Boolean]
For points with an extent, like columns, whether to align the data label inside the box or to the actual value point.
For points with an extent, like columns, whether to align the data label inside the box or to the actual value point. Defaults to
falsein most cases,truein stacked columns.- Since
3.0
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
overflow: UndefOr[String]
How to handle data labels that flow outside the plot area.
How to handle data labels that flow outside the plot area. The default is
justify, which aligns them inside the plot area. For columns and bars, this means it will be moved inside the bar. To display data labels outside the plot area, setcroptofalseandoverflowto"none".- Since
3.0.6
-
val
padding: UndefOr[Double]
When either the
borderWidthor thebackgroundColoris set, this is the padding within the box.When either the
borderWidthor thebackgroundColoris set, this is the padding within the box.- Since
2.2.1
Example: -
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
rotation: UndefOr[Double]
Text rotation in degrees.
Text rotation in degrees. Note that due to a more complex structure, backgrounds, borders and padding will be lost on a rotated data label.
Example: -
val
shadow: UndefOr[|[Boolean, Object]]
The shadow of the box.
The shadow of the box. Works best with
borderWidthorbackgroundColor. Since 2.3 the shadow can be an object configuration containingcolor,offsetX,offsetY,opacityandwidth.- Since
2.2.1
Example: -
val
shape: UndefOr[String]
The name of a symbol to use for the border around the label.
The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object.
- Since
4.1.2
Example: -
val
softConnector: UndefOr[Boolean]
Whether to render the connector as a soft arc or a line with sharp break.
-
val
style: UndefOr[Object]
Styles for the label.
Styles for the label.
- Since
4.1.0
Example: -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
useHTML: UndefOr[Boolean]
Whether to use HTML to render the labels.
Whether to use HTML to render the labels.
-
def
valueOf(): Any
- Definition Classes
- Object
-
val
verticalAlign: UndefOr[String]
The vertical alignment of a data label.
The vertical alignment of a data label. Can be one of
top,middleorbottom. The default value depends on the data, for instance in a column chart, the label is above positive values and below negative values.- Since
2.3.3
-
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( ... )
-
val
x: UndefOr[Double]
The x position offset of the label relative to the point.
The x position offset of the label relative to the point.
Example: -
val
y: UndefOr[Double]
The y position offset of the label relative to the point.
The y position offset of the label relative to the point.
Example: -
val
zIndex: UndefOr[Double]
The Z index of the data labels.
The Z index of the data labels. The default Z index puts it above the series. Use a Z index of 2 to display it behind the series.
- Since
2.3.5