Interface PageFloatFragment

interface PageFloatFragment {
    area: Vtree.Container;
    clearSide: string;
    continuations: PageFloats.PageFloatContinuation[];
    continues: boolean;
    floatReference: PageFloats.FloatReference;
    floatSide: string;
    addContinuations(continuations: PageFloats.PageFloatContinuation[]): void;
    findNotAllowedFloat(
        context: PageFloats.PageFloatLayoutContext,
    ): PageFloats.PageFloat;
    getFlowName(): string;
    getOrder(): number;
    getOuterRect(): Rect;
    getOuterShape(): Shape;
    hasFloat(float: PageFloats.PageFloat): boolean;
    shouldBeStashedBefore(float: PageFloats.PageFloat): boolean;
}

Implemented by

PageFloatFragment

Index

Properties

area clearSide continuations continues floatReference floatSide

Methods

addContinuations findNotAllowedFloat getFlowName getOrder getOuterRect getOuterShape hasFloat shouldBeStashedBefore

Properties

`Readonly`area

area: Vtree.Container

`Readonly`clearSide

clearSide: string

`Readonly`continuations

continuations: PageFloats.PageFloatContinuation[]

`Readonly`continues

continues: boolean

`Readonly`floatReference

floatReference: PageFloats.FloatReference

`Readonly`floatSide

floatSide: string

Methods

addContinuations

addContinuations(continuations: PageFloats.PageFloatContinuation[]): void
Parameters
- continuations: PageFloats.PageFloatContinuation[]
Returns void
- Defined in types.ts:671

findNotAllowedFloat

findNotAllowedFloat(
context: PageFloats.PageFloatLayoutContext,
): PageFloats.PageFloat
Parameters
- context: PageFloats.PageFloatLayoutContext
Returns PageFloats.PageFloat
- Defined in types.ts:666

getFlowName

getFlowName(): string
Returns string
- Defined in types.ts:672

getOrder

getOrder(): number
Returns number
- Defined in types.ts:669

getOuterRect

getOuterRect(): Rect
Returns Rect
- Defined in types.ts:668

getOuterShape

getOuterShape(): Shape
Returns Shape
- Defined in types.ts:667

hasFloat

hasFloat(float: PageFloats.PageFloat): boolean
Parameters
- float: PageFloats.PageFloat
Returns boolean
- Defined in types.ts:665

shouldBeStashedBefore

shouldBeStashedBefore(float: PageFloats.PageFloat): boolean
Parameters
- float: PageFloats.PageFloat
Returns boolean
- Defined in types.ts:670