Class FootnoteFragment

Hierarchy

PageFloatFragment
- FootnoteFragment

Index

Constructors

Properties

area clearSide continuations continues floatReference floatSide

Methods

addContinuations findNotAllowedFloat getFlowName getOrder getOuterRect getOuterShape hasFloat shouldBeStashedBefore

Constructors

constructor

new FootnoteFragment(
    floatReference: PageFloats.FloatReference,
    continuations: PageFloatContinuation[],
    area: Container,
    continues: boolean,
): FootnoteFragment
Parameters
- floatReference: PageFloats.FloatReference
- continuations: PageFloatContinuation[]
- area: Container
- continues: boolean
Returns FootnoteFragment
Overrides PageFloatFragment.constructor
- Defined in footnotes.ts:56

Properties

`Readonly`area

area: Vtree.Container

`Readonly`clearSide

clearSide: string

`Readonly`continuations

continuations: PageFloatContinuation[]

`Readonly`continues

continues: boolean

`Readonly`floatReference

floatReference: PageFloats.FloatReference

`Readonly`floatSide

floatSide: string

Methods

addContinuations

addContinuations(continuations: PageFloatContinuation[]): void
Parameters
- continuations: PageFloatContinuation[]
Returns void
Inherited from PageFloatFragment.addContinuations
- Defined in page-floats.ts:237

findNotAllowedFloat

findNotAllowedFloat(context: PageFloatLayoutContext): PageFloat
Parameters
- context: PageFloatLayoutContext
Returns PageFloat
Inherited from PageFloatFragment.findNotAllowedFloat
- Defined in page-floats.ts:207

getFlowName

getFlowName(): string
Returns string
Inherited from PageFloatFragment.getFlowName
- Defined in page-floats.ts:243

getOrder

getOrder(): number
Returns number
Overrides PageFloatFragment.getOrder
- Defined in footnotes.ts:65

getOuterRect

getOuterRect(): Rect
Returns Rect
Inherited from PageFloatFragment.getOuterRect
- Defined in page-floats.ts:221

getOuterShape

getOuterShape(): Shape
Returns Shape
Inherited from PageFloatFragment.getOuterShape
- Defined in page-floats.ts:217

hasFloat

hasFloat(float: PageFloat): boolean
Parameters
- float: PageFloat
Returns boolean
Inherited from PageFloatFragment.hasFloat
- Defined in page-floats.ts:203

shouldBeStashedBefore

shouldBeStashedBefore(float: PageFloat): boolean
Parameters
- float: PageFloat
Returns boolean
Overrides PageFloatFragment.shouldBeStashedBefore
- Defined in footnotes.ts:69