HTML Flip Book - v0.0.0-alpha.36
    Preparing search index...

    Interface PageFlipParams

    Params passed to onPageFlipping and onPageFlipped. Describes the spread (target for flipping, current for flipped): leaf index, page indices, semantics, direction.

    interface PageFlipParams {
        direction: PageFlipDirection;
        leafIndex: number;
        pageIndices: [number, number];
        semantics: [FlipPageSemantic | undefined, FlipPageSemantic | undefined];
    }
    Index

    Properties

    direction leafIndex pageIndices semantics

    Properties

    direction: PageFlipDirection

    Direction of the flip.

    leafIndex: number

    Index of the leaf that is (being) turned.

    pageIndices: [number, number]

    Left and right page indices of the spread (after the flip).

    semantics: [FlipPageSemantic | undefined, FlipPageSemantic | undefined]

    Semantic info for the two pages; undefined when pageSemantics not set.

    Settings

    Member Visibility

    On This Page

    Properties