Kiri API reference
    Preparing search index...

    Interface LoadOptions

    Options for load().

    interface LoadOptions {
        zoom?: number;
        offset?: Offset;
        rotation?: number;
        flip?: Partial<Flip>;
    }
    Index
    zoom? offset? rotation? flip?
    zoom?: number

    Clamped to [minZoom, maxZoom]. Default minZoom. Ignored when movableFrame: true — the image always renders at its fixed size from the first frame, same as setZoom() being a no-op in that mode.

    offset?: Offset

    Clamped so the frame stays covered by the image. Default { x: 0, y: 0 }. Ignored when movableFrame: true, same as zoom above.

    rotation?: number

    Degrees, snapped to the nearest 90°. Default 0.

    flip?: Partial<Flip>

    Default { horizontal: false, vertical: false }.

    Settings
    Member Visibility

    On This Page
    Properties