Skip to main content
Version: 0.12

Text Layer

etro.layer.Text renders text.

Usage​

const layer = new etro.layer.Text({
  startTime: 0,
  duration: 5,
  text: "Hello World",
  x: 0, // default: 0
  y: 0, // default: 0
  width: 400, // default: null (full width)
  height: 400, // default: null (full height)
  opacity: 1, // default: 1
  color: etro.parseColor("white"), // default: new etro.Color(0, 0, 0, 1)
  font: "10px sans-serif", // default: '10px sans-serif'
  textX: 20, // default: 0
  textY: 20, // default: 0
  textAlign: "left", // default: 'left'
  textBaseline: "alphabetic", // default: 'alphabetic'
  textDirection: "ltr", // default: 'ltr'
  textStroke: {
    // default: null (no stroke)
    color: etro.parseColor("black"),
    position: TextStrokePosition.Outside, // default: TextStrokePosition.Outside
    thickness: 2, // default: 1
  },
});

Inheritance​

etro.layer.Text inherits from etro.layer.Visual.

Options​

text (required)​

tip

This is a Dynamic Property.

The text to render.

color​

tip

This is a Dynamic Property.

The color of the text. The default value is new etro.Color(0, 0, 0, 1).

font​

tip

This is a Dynamic Property.

The CSS font to use. The default value is '10px sans-serif'.

textX​

tip

This is a Dynamic Property.

The x position to render the text at. The default value is 0.

textY​

tip

This is a Dynamic Property.

The y position to render the text at. The default value is 0.

textAlign​

tip

This is a Dynamic Property.

The alignment of the text. The default value is 'left'.

textBaseline​

tip

This is a Dynamic Property.

The baseline of the text. The default value is 'alphabetic'.

textDirection​

tip

This is a Dynamic Property.

The direction of the text. The default value is 'ltr'.

textStroke​

tip

This is a Dynamic Property.

The text's outline. The default value is null, or no outline.

textStroke.color​

A Color instance for the outline. Required in order to render the text's outline.

textStroke.position​

Where to render the outline, relative to the text. Can be set to any of the following:

  • TextStrokePosition.Outside (default)
  • TextStrokePosition.Center
  • TextStrokePosition.Inside

textStroke.thickness​

Positive number indicating the thickness of the outline. The default value is 1.0.