Interface AbstractBreakPosition

Potential breaking position.

interface AbstractBreakPosition {
    breakPositionChosen(column: Layout.Column): void;
    calculateOffset(
        column: Layout.Column,
    ): { current: number; minimum: number };
    findAcceptableBreak(
        column: Layout.Column,
        penalty: number,
    ): Vtree.NodeContext;
    getMinBreakPenalty(): number;
    getNodeContext(): Vtree.NodeContext;
}

Hierarchy (View Summary)

Layout.BreakPosition
- AbstractBreakPosition
  - Layout.BoxBreakPosition
  - Layout.EdgeBreakPosition

Implemented by

AbstractBreakPosition

Index

Methods

breakPositionChosen calculateOffset findAcceptableBreak getMinBreakPenalty getNodeContext

Methods

breakPositionChosen

breakPositionChosen(column: Layout.Column): void
Parameters
- column: Layout.Column
Returns void
Inherited from BreakPosition.breakPositionChosen
- Defined in types.ts:102

calculateOffset

calculateOffset(column: Layout.Column): { current: number; minimum: number }
Parameters
- column: Layout.Column
Returns { current: number; minimum: number }
Inherited from BreakPosition.calculateOffset
- Defined in types.ts:101

findAcceptableBreak

findAcceptableBreak(column: Layout.Column, penalty: number): Vtree.NodeContext
Parameters
- column: Layout.Column
- penalty: number
Returns Vtree.NodeContext
break position, if found
Inherited from BreakPosition.findAcceptableBreak
- Defined in types.ts:96

getMinBreakPenalty

getMinBreakPenalty(): number
Returns number
penalty for this break position
Inherited from BreakPosition.getMinBreakPenalty
- Defined in types.ts:100

getNodeContext

getNodeContext(): Vtree.NodeContext
Returns Vtree.NodeContext
- Defined in types.ts:106