Class PageFloat

Hierarchy (View Summary)

PageFloat
- Footnote

Implements

PageFloats.PageFloat

Index

Constructors

Properties

clearSide floatMinWrapBlock floatReference floatSide flowName id nodePosition order

Methods

getId getOrder isAllowedOnContext isAllowedToPrecede

Constructors

constructor

new PageFloat(
    nodePosition: Vtree.NodePosition,
    floatReference: PageFloats.FloatReference,
    floatSide: string,
    clearSide: string,
    flowName: string,
    floatMinWrapBlock: Numeric,
): PageFloat
Parameters
- nodePosition: Vtree.NodePosition
- floatReference: PageFloats.FloatReference
- floatSide: string
- clearSide: string
- flowName: string
- floatMinWrapBlock: Numeric
Returns PageFloat
- Defined in page-floats.ts:115

Properties

`Readonly`clearSide

clearSide: string

`Readonly`floatMinWrapBlock

floatMinWrapBlock: Numeric

`Readonly`floatReference

floatReference: PageFloats.FloatReference

`Readonly`floatSide

floatSide: string

`Readonly`flowName

flowName: string

id

id: string = null

`Readonly`nodePosition

nodePosition: Vtree.NodePosition

order

order: number = null

Methods

getId

getId(): string
Returns string
Implementation of PageFloat.getId
- Defined in page-floats.ts:131

getOrder

getOrder(): number
Returns number
Implementation of PageFloat.getOrder
- Defined in page-floats.ts:124

isAllowedOnContext

isAllowedOnContext(pageFloatLayoutContext: PageFloatLayoutContext): boolean
Parameters
- pageFloatLayoutContext: PageFloatLayoutContext
Returns boolean
Implementation of PageFloat.isAllowedOnContext
- Defined in page-floats.ts:138

isAllowedToPrecede

isAllowedToPrecede(other: PageFloat): boolean
Parameters
- other: PageFloat
Returns boolean
Implementation of PageFloat.isAllowedToPrecede
- Defined in page-floats.ts:142