Title

@JSType
trait Title extends StObject with BaseTitle
Companion
object
trait BaseTitle
trait StObject
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Inherited methods

def hasOwnProperty(v: String): Boolean
Inherited from
Object
def isPrototypeOf(v: Object): Boolean
Inherited from
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from
Object
def toLocaleString(): String
Inherited from
Object
def valueOf(): Any
Inherited from
Object

Abstract fields

@ExposedJSMember

The title text.

The title text.

Concrete fields

@ExposedJSMember @JSOptional

Mark definitions for custom title encoding.

Mark definitions for custom title encoding.

@ExposedJSMember @JSOptional
var interactive: UndefOr[Boolean]

A boolean flag indicating if the title element should respond to input events such as mouse hover. (Deprecated.)

A boolean flag indicating if the title element should respond to input events such as mouse hover. (Deprecated.)

@ExposedJSMember @JSOptional
var name: UndefOr[String]

A mark name property to apply to the title text mark. (Deprecated.)

A mark name property to apply to the title text mark. (Deprecated.)

@ExposedJSMember @JSOptional
var style: UndefOr[String | Array[String]]

A mark style property to apply to the title text mark. If not specified, a default style of "group-title" is applied. (Deprecated)

A mark style property to apply to the title text mark. If not specified, a default style of "group-title" is applied. (Deprecated)

@ExposedJSMember @JSOptional
var subtitle: UndefOr[Text | SignalRef]

The subtitle text.

The subtitle text.

Inherited fields

@ExposedJSMember @JSOptional
var align: UndefOr[AlignValue]

Horizontal text alignment for title text. One of "left", "center", or "right".

Horizontal text alignment for title text. One of "left", "center", or "right".

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var anchor: UndefOr[AnchorValue]

The anchor position for placing the title and subtitle text. One of "start", "middle", or "end". For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.

The anchor position for placing the title and subtitle text. One of "start", "middle", or "end". For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var angle: UndefOr[NumberValue]

Angle in degrees of title and subtitle text.

Angle in degrees of title and subtitle text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var aria: UndefOr[Boolean]

A boolean flag indicating if ARIA attributes should be included (SVG output only). If false, the "aria-hidden" attribute will be set on the output SVG group, removing the title from the ARIA accessibility tree.

A boolean flag indicating if ARIA attributes should be included (SVG output only). If false, the "aria-hidden" attribute will be set on the output SVG group, removing the title from the ARIA accessibility tree.

Default value: true

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

Vertical text baseline for title and subtitle text. One of "alphabetic" (default), "top", "middle", "bottom", "line-top", or "line-bottom". The "line-top" and "line-bottom" values operate similarly to "top" and "bottom", but are calculated relative to the lineHeight rather than fontSize alone.

Vertical text baseline for title and subtitle text. One of "alphabetic" (default), "top", "middle", "bottom", "line-top", or "line-bottom". The "line-top" and "line-bottom" values operate similarly to "top" and "bottom", but are calculated relative to the lineHeight rather than fontSize alone.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var color: UndefOr[ColorValue]

Text color for title text.

Text color for title text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var dx: UndefOr[NumberValue]

Delta offset for title and subtitle text x-coordinate.

Delta offset for title and subtitle text x-coordinate.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var dy: UndefOr[NumberValue]

Delta offset for title and subtitle text y-coordinate.

Delta offset for title and subtitle text y-coordinate.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var font: UndefOr[StringValue]

Font name for title text.

Font name for title text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var fontSize: UndefOr[NumberValue]

Font size in pixels for title text.

Font size in pixels for title text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

Font style for title text.

Font style for title text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

Font weight for title text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, ..., 900 where "normal" = 400 and "bold" = 700).

Font weight for title text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, ..., 900 where "normal" = 400 and "bold" = 700).

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var frame: UndefOr[TitleFrame | StringValue]

The reference frame for the anchor position, one of "bounds" (to anchor relative to the full bounding box) or "group" (to anchor relative to the group width or height).

The reference frame for the anchor position, one of "bounds" (to anchor relative to the full bounding box) or "group" (to anchor relative to the group width or height).

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var limit: UndefOr[NumberValue]

The maximum allowed length in pixels of title and subtitle text.

The maximum allowed length in pixels of title and subtitle text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var lineHeight: UndefOr[NumberValue]

Line height in pixels for multi-line title text or title text with "line-top" or "line-bottom" baseline.

Line height in pixels for multi-line title text or title text with "line-top" or "line-bottom" baseline.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var offset: UndefOr[NumberValue]

The orthogonal offset in pixels by which to displace the title group from its position along the edge of the chart.

The orthogonal offset in pixels by which to displace the title group from its position along the edge of the chart.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var orient: UndefOr[TitleOrient | SignalRef]

Default title orientation ("top", "bottom", "left", or "right")

Default title orientation ("top", "bottom", "left", or "right")

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

Text color for subtitle text.

Text color for subtitle text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

Font name for subtitle text.

Font name for subtitle text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

Font size in pixels for subtitle text.

Font size in pixels for subtitle text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

Font style for subtitle text.

Font style for subtitle text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

Font weight for subtitle text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, ..., 900 where "normal" = 400 and "bold" = 700).

Font weight for subtitle text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, ..., 900 where "normal" = 400 and "bold" = 700).

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

Line height in pixels for multi-line subtitle text.

Line height in pixels for multi-line subtitle text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional

The padding in pixels between title and subtitle text.

The padding in pixels between title and subtitle text.

Inherited from
BaseTitle
@ExposedJSMember @JSOptional
var zindex: UndefOr[Double]

The integer z-index indicating the layering of the title group relative to other axis, mark, and legend groups.

The integer z-index indicating the layering of the title group relative to other axis, mark, and legend groups.

Default value: 0.

Inherited from
BaseTitle