creator.lottiefiles.com

read_keyframes

Read the current keyframes on a layer's keyframe-tool properties. Use this whenever the user asks to TUNE, POLISH, or MODIFY an existing animation ('make the bounce snappier', 'slow down the fade', 'shift this 10 frames later', 'make the rotation smoother') — so you can see what's actually there before changing it, instead of rebuilding from scratch. Without `property`, returns a map of the core properties handled by `apply_keyframes` (`position`, `scale`, `rotation`, `opacity`, `fill_color`, trim path fields, and `stroke_width`). With `property`, returns just that explicit core or extended property. Extended properties such as masks, shape paths, gradients, text animator fields, and time mapping must be named explicitly; they are not included in the bulk read. For static (non-animated) properties, `is_animated` is false and `static_value` is returned instead of keyframes. **For `position` on a TEXT layer, `static_value` is the RAW transform (baseline / box-origin anchor) — NOT the visual center. To animate a text position relative to its rest (the only safe way), keyframe from THIS `static_value`, not from `visual_center`. For a settle-into-place entrance, prefer `animate_entrance`, which reads this for you.** Easing in returned keyframes comes through as the raw stored shape: `{ type: "LINEAR" }` or `{ type: "CUBIC_BEZIER", x1, y1, x2, y2 }`. (Named presets are expanded at write-time, so reads only see the resolved bezier coefficients.)

Input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "layer_id": {
      "type": "string"
    },
    "property": {
      "description": "Optional — restrict to one core or extended keyframe-tool property. Omit to read all core keyframe-tool properties on the layer.",
      "type": "string",
      "enum": [
        "position",
        "scale",
        "rotation",
        "opacity",
        "fill_color",
        "trim_start",
        "trim_end",
        "trim_offset",
        "stroke_width",
        "stroke_color",
        "fill_opacity",
        "stroke_opacity",
        "gradient_stops",
        "gradient_start",
        "gradient_end",
        "highlight_angle",
        "highlight_length",
        "shape_path",
        "shape_size",
        "rectangle_roundness",
        "outer_radius",
        "inner_radius",
        "outer_roundness",
        "inner_roundness",
        "polygon_points",
        "star_points",
        "text_fill_color",
        "text_stroke_color",
        "text_stroke_width",
        "mask_path",
        "mask_opacity",
        "time_mapping"
      ]
    }
  },
  "required": [
    "layer_id"
  ],
  "additionalProperties": false
}