@vivliostyle/core
    Preparing search index...

    Interface PageFloatLayoutContext

    interface PageFloatLayoutContext {
        direction: Val;
        effectiveParent: PageFloats.PageFloatLayoutContext;
        floatFragments: PageFloats.PageFloatFragment[];
        flowName: string;
        generatingNodePosition: Vtree.NodePosition;
        ignoreFootnoteAreaMaxHeight: boolean;
        parent: PageFloats.PageFloatLayoutContext;
        addLayoutConstraint(
            layoutConstraint: Layout.LayoutConstraint,
            floatReference: PageFloats.FloatReference,
        ): void;
        addPageFloat(float: PageFloats.PageFloat): void;
        deferPageFloat(continuation: PageFloats.PageFloatContinuation): void;
        discardStashedFragments(floatReference: PageFloats.FloatReference): void;
        findPageFloatByNodePosition(
            nodePosition: Vtree.NodePosition,
        ): PageFloats.PageFloat;
        findPageFloatFragment(
            float: PageFloats.PageFloat,
        ): PageFloats.PageFloatFragment;
        getDeferredPageFloatContinuations(
            flowName?: string,
        ): PageFloats.PageFloatContinuation[];
        getFloatFragmentExclusions(): Shape[];
        getLayoutConstraints(): Layout.LayoutConstraint[];
        getPageFloatContinuationsDeferredToNext(
            flowName?: string,
        ): PageFloats.PageFloatContinuation[];
        getPageFloatLayoutContext(
            floatReference: PageFloats.FloatReference,
        ): PageFloats.PageFloatLayoutContext;
        getStashedFloatFragments(
            floatReference: PageFloats.FloatReference,
        ): PageFloats.PageFloatFragment[];
        hasContinuingFloatFragmentsInFlow(flowName: string): boolean;
        hasFloatFragments(
            condition?: (p1: PageFloats.PageFloatFragment) => boolean,
        ): boolean;
        hasPrecedingFloatsDeferredToNext(
            float: PageFloats.PageFloat,
            ignoreReference?: boolean,
        ): boolean;
        isForbidden(float: PageFloats.PageFloat): boolean;
        isInvalidated(): boolean;
        isLocked(): boolean;
        lock(): void;
        markPageFloatAnchorSeen(float: PageFloats.PageFloat): void;
        registerPageFloatAnchor(
            float: PageFloats.PageFloat,
            anchorViewNode: Node,
        ): void;
        removeFloatDeferredToNext(float: PageFloats.PageFloat): void;
        unlock(): void;
        validate(): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    direction effectiveParent floatFragments flowName generatingNodePosition ignoreFootnoteAreaMaxHeight parent

    Methods

    addLayoutConstraint addPageFloat deferPageFloat discardStashedFragments findPageFloatByNodePosition findPageFloatFragment getDeferredPageFloatContinuations getFloatFragmentExclusions getLayoutConstraints getPageFloatContinuationsDeferredToNext getPageFloatLayoutContext getStashedFloatFragments hasContinuingFloatFragmentsInFlow hasFloatFragments hasPrecedingFloatsDeferredToNext isForbidden isInvalidated isLocked lock markPageFloatAnchorSeen registerPageFloatAnchor removeFloatDeferredToNext unlock validate

    Properties

    direction: Val
    effectiveParent: PageFloats.PageFloatLayoutContext
    floatFragments: PageFloats.PageFloatFragment[]
    flowName: string
    generatingNodePosition: Vtree.NodePosition
    ignoreFootnoteAreaMaxHeight: boolean
    parent: PageFloats.PageFloatLayoutContext

    Methods

    • Parameters

      • flowName: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods