Type Alias TextShapeOptions

TextShapeOptions: ShapeEntryBase & {
    fontFamily?: string;
    fontWeight?: number | "normal" | "bold";
    size?: Range<Pixels>;
    text: OneOrMany<string>;
    type: "text";
}

Text Shape Entry. Words or letters filled with the particle colors (one cached bitmap per text × color).

Type Declaration

Optional ReadonlyfontFamily?: string

Font Family. Make sure web fonts are loaded before firing (document.fonts.ready).

Default Value
"system-ui, sans-serif"
Optional ReadonlyfontWeight?: number | "normal" | "bold"

Font Weight.

Default Value
700
Optional Readonlysize?: Range<Pixels>

Font Size.

Default Value
[14, 22]
Readonlytext: OneOrMany<string>

Text Content(s).
Readonlytype: "text"

Shape Type.

Example

shapes: [{ type: "text", text: ["YAY", "WOW"], fontWeight: 900, colors: ["#ff0a54", "#00c2ff"] }]

Type Alias TextShapeOptions

Type Declaration

`Optional` `Readonly`fontFamily?: string

Default Value

`Optional` `Readonly`fontWeight?: number | "normal" | "bold"

Default Value

`Optional` `Readonly`size?: Range<Pixels>

Default Value

`Readonly`text: OneOrMany<string>

`Readonly`type: "text"

Example

Settings

Type Alias TextShapeOptions

Type Declaration

Optional ReadonlyfontFamily?: string

Default Value

Optional ReadonlyfontWeight?: number | "normal" | "bold"

Default Value

Optional Readonlysize?: Range<Pixels>

Default Value

Readonlytext: OneOrMany<string>

Readonlytype: "text"

Example

Settings

`Optional` `Readonly`fontFamily?: string

`Optional` `Readonly`fontWeight?: number | "normal" | "bold"

`Optional` `Readonly`size?: Range<Pixels>

`Readonly`text: OneOrMany<string>

`Readonly`type: "text"