creator.lottiefiles.com

measure_text_units

Return per-line, per-word, and per-character bounds for an existing text layer. Uses the same canvas.measureText pipeline that powers `read_scene`'s `measured_bounds`, but exposes the cumulative pen position per glyph so per-character recipes can place each new layer at the source's exact kerning — no `bounds.width / char_count` approximation. When to call (REQUIRED before splitting): - Any per-character recipe (typewriter, per-character-rise, bottom-up-letters, top-down-letters, kinetic-center-build, short-slide-*). - Any per-word recipe where each word needs its own layer (per-word-crossfade, spring-scale-in) so the rebuilt phrase reads as one centered unit. - Layout-aware effects that need exact word widths (short-slide-down, short-slide-right, kinetic-center-build). When NOT to call: - Whole-layer recipes (micro-scale-fade, fade-through, scale-down-fade, mask-reveal-up) — those animate one layer; `read_scene`'s `visual_bounds` is enough. - Layers that aren't text — call returns an error. Returns (positions match `read_scene`'s coordinate system): - `local_bounds` / `world_bounds` for the whole layer (matches `text_style.measured_bounds` and `layout.visual_bounds` from `read_scene`). - `font`: `{ name, size, tracking, line_height, alignment }` — pass these to `create_text` per character/word/line to preserve the source typeface. - `lines[]`: one entry per `\n`-separated line. Each line carries `text`, `local_bounds`, `world_bounds`, and optionally `words[]` / `characters[]` depending on `granularity`. - `characters[i].local_bounds.x + width/2` is the visual CENTER of glyph i; use that as the `position.x` for the per-character layer. - `characters[i].advance_x_local` is the pen position AFTER glyph i (left edge of glyph i+1 with tracking applied). Sum across glyphs and you reproduce the line width. Granularity: - `line` — only line bounds. Cheapest. Use for per-line recipes. - `word` — adds word bounds inside each line. Use for per-word recipes. - `character` — a…

Input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "layer_id": {
      "description": "Text layer id from `read_scene`. Pass the source phrase's layer id before splitting it.",
      "type": "string"
    },
    "granularity": {
      "description": "Which units to return. Default 'all' (words + characters per line). Use 'character' for per-character recipes, 'word' for per-word, 'line' for per-line.",
      "type": "string",
      "enum": [
        "line",
        "word",
        "character",
        "all"
      ]
    }
  },
  "required": [
    "layer_id"
  ],
  "additionalProperties": false
}