dotlottie-js API Reference

The API Reference for dotlottie-js provides detailed information about the public classes, methods, and utility functions for creating, manipulating, and exporting .lottie files.

The reference includes:

1. The DotLottie (V2) Class: The primary class for working with V2 format .lottie files. Includes constructor, static loading methods, and instance methods for managing animations, assets, themes, state machines, and exporting.

2. The DotLottieV1 Class: For users explicitly creating or managing V1 format .lottie files.

3. Standalone Utility Functions: A collection of publicly exported functions for tasks like instance creation, conversion, loading, validation, data extraction, and more.

Structure

This API reference is organized as follows:

• DotLottie (V2) Class: Details the main class for V2 operations.

  • Constructor & Options

  • Instance Loading Methods (fromArrayBuffer, fromURL)

  • Instance Properties (manifest, animations, themes, etc.)

  • Animation Management Methods (addAnimation, getAnimation, removeAnimation)

  • Asset Management Methods (getImages, getAudio)

  • Theme Management Methods (addTheme, getTheme, removeTheme)

  • State Machine Management Methods (addStateMachine, getStateMachine, removeStateMachine)

  • Merge Method (merge)

  • Building & Exporting Methods (build, toArrayBuffer, toBlob, toBase64, download)

• DotLottieV1 Class: Details the class for V1 operations.

  • Constructor & Options

  • Instance Methods (addAnimation, build, toArrayBuffer, etc.)

• Standalone Utilities: Describes various utility functions, categorized as:

  • Instance Creation & Version Conversion

  • Loading & Validation

  • Data Extraction

  • Asset Handling

  • Data Conversion & Helpers

  • ZIP Handling

  • Error Handling

Navigate using the links above or proceed sequentially.

Next up: DotLottie (V2) Class API