Class EdgeBreakPosition

Potential edge breaking position.

Hierarchy (View Summary)

AbstractBreakPosition
- EdgeBreakPosition
  - BetweenTableRowBreakPosition
  - EntireTableBreakPosition

Implements

Layout.EdgeBreakPosition

Index

Constructors

Properties

breakOnEdge computedBlockSize isEdgeUpdated overflowIfRepetitiveElementsDropped overflows position

Methods

breakPositionChosen calculateOffset findAcceptableBreak getMinBreakPenalty getNodeContext

Constructors

constructor

new EdgeBreakPosition(
    position: Vtree.NodeContext,
    breakOnEdge: string,
    overflows: boolean,
    computedBlockSize: number,
): EdgeBreakPosition
Parameters
- position: Vtree.NodeContext
- breakOnEdge: string
- overflows: boolean
- computedBlockSize: number
Returns EdgeBreakPosition
Overrides AbstractBreakPosition.constructor
- Defined in break-position.ts:82

Properties

`Readonly`breakOnEdge

breakOnEdge: string

`Readonly`computedBlockSize

computedBlockSize: number

`Protected`isEdgeUpdated

isEdgeUpdated: boolean = false

overflowIfRepetitiveElementsDropped

overflowIfRepetitiveElementsDropped: boolean

overflows

overflows: boolean

`Readonly`position

position: Vtree.NodeContext

Methods

breakPositionChosen

breakPositionChosen(column: Layout.Column): void
Parameters
- column: Layout.Column
Returns void
Implementation of EdgeBreakPosition.breakPositionChosen
Inherited from AbstractBreakPosition.breakPositionChosen
- Defined in break-position.ts:46

calculateOffset

calculateOffset(column: any): { current: number; minimum: number }
Parameters
- column: any
Returns { current: number; minimum: number }
Implementation of EdgeBreakPosition.calculateOffset
Inherited from AbstractBreakPosition.calculateOffset
- Defined in break-position.ts:38

findAcceptableBreak

findAcceptableBreak(column: Layout.Column, penalty: number): Vtree.NodeContext
Parameters
- column: Layout.Column
- penalty: number
Returns Vtree.NodeContext
break position, if found
Implementation of EdgeBreakPosition.findAcceptableBreak
Overrides AbstractBreakPosition.findAcceptableBreak
- Defined in break-position.ts:92

getMinBreakPenalty

getMinBreakPenalty(): number
Returns number
penalty for this break position
Implementation of EdgeBreakPosition.getMinBreakPenalty
Overrides AbstractBreakPosition.getMinBreakPenalty
- Defined in break-position.ts:103

getNodeContext

getNodeContext(): Vtree.NodeContext
Returns Vtree.NodeContext
Implementation of EdgeBreakPosition.getNodeContext
Overrides AbstractBreakPosition.getNodeContext
- Defined in break-position.ts:191