@vivliostyle/core
    Preparing search index...

    Interface NodeContext

    NodeContext represents a position in the document + layout-related information attached to it. When after=false and offsetInNode=0, the position is inside the element (node), but just before its first child. When offsetInNode>0 it represents offset in the textual content of the node. When after=true it represents position right after the last child of the node. boxOffset is incremented by 1 for any valid node position.

    interface NodeContext {
        after: boolean;
        afterIfContinues: Selectors.AfterIfContinues;
        blockBorderSpacing: number;
        boxOffset: number;
        breakAfter: string;
        breakBefore: string;
        breakPenalty: number;
        breakWord: boolean;
        captionSide: string;
        clearSide: string;
        clearSpacer: Node;
        columnSpan: Val;
        containingBlockForAbsolute: boolean;
        direction: string;
        display: string;
        establishesBFC: boolean;
        firstPseudo: Vtree.FirstPseudo;
        flexContainer: boolean;
        floatMinWrapBlock: Numeric;
        floatReference: PageFloats.FloatReference;
        floatSide: string;
        footnotePolicy: Ident;
        formattingContext: Vtree.FormattingContext;
        fragmentIndex: number;
        hyphenateCharacter: string;
        inheritedProps: { [key: string]: string | number | Val };
        inline: boolean;
        inlineBorderSpacing: number;
        lang: string;
        nodeShadow: Vtree.ShadowContext;
        offsetInNode: number;
        overflow: boolean;
        pageType: string;
        parent: Vtree.NodeContext;
        pluginProps: { [key: string]: string | number | number[] };
        preprocessedTextContent: Change[];
        repeatOnBreak: string;
        shadowContext: Vtree.ShadowContext;
        shadowSibling: Vtree.NodeContext;
        shadowType: Vtree.ShadowType;
        shared: boolean;
        sourceNode: Node;
        vertical: boolean;
        verticalAlign: string;
        viewNode: Node;
        whitespace: Vtree.Whitespace;
        belongsTo(formattingContext: Vtree.FormattingContext): boolean;
        clone(): Vtree.NodeContext;
        copy(): Vtree.NodeContext;
        getContainingBlockForAbsolute(): Vtree.NodeContext;
        isInsideBFC(): boolean;
        modify(): Vtree.NodeContext;
        resetView(): void;
        toNodePosition(): Vtree.NodePosition;
        toNodePositionStep(): Vtree.NodePositionStep;
    }

    Implemented by

    Index

    Properties

    after afterIfContinues blockBorderSpacing boxOffset breakAfter breakBefore breakPenalty breakWord captionSide clearSide clearSpacer columnSpan containingBlockForAbsolute direction display establishesBFC firstPseudo flexContainer floatMinWrapBlock floatReference floatSide footnotePolicy formattingContext fragmentIndex hyphenateCharacter inheritedProps inline inlineBorderSpacing lang nodeShadow offsetInNode overflow pageType parent pluginProps preprocessedTextContent repeatOnBreak shadowContext shadowSibling shadowType shared sourceNode vertical verticalAlign viewNode whitespace

    Methods

    belongsTo clone copy getContainingBlockForAbsolute isInsideBFC modify resetView toNodePosition toNodePositionStep

    Properties

    after: boolean
    afterIfContinues: Selectors.AfterIfContinues
    blockBorderSpacing: number
    boxOffset: number
    breakAfter: string
    breakBefore: string
    breakPenalty: number
    breakWord: boolean
    captionSide: string
    clearSide: string
    clearSpacer: Node
    columnSpan: Val
    containingBlockForAbsolute: boolean
    direction: string
    display: string
    establishesBFC: boolean
    firstPseudo: Vtree.FirstPseudo
    flexContainer: boolean
    floatMinWrapBlock: Numeric
    floatReference: PageFloats.FloatReference
    floatSide: string
    footnotePolicy: Ident
    formattingContext: Vtree.FormattingContext
    fragmentIndex: number
    hyphenateCharacter: string
    inheritedProps: { [key: string]: string | number | Val }
    inline: boolean
    inlineBorderSpacing: number
    lang: string
    nodeShadow: Vtree.ShadowContext
    offsetInNode: number
    overflow: boolean
    pageType: string
    parent: Vtree.NodeContext
    pluginProps: { [key: string]: string | number | number[] }
    preprocessedTextContent: Change[]
    repeatOnBreak: string
    shadowContext: Vtree.ShadowContext
    shadowSibling: Vtree.NodeContext
    shadowType: Vtree.ShadowType
    shared: boolean
    sourceNode: Node
    vertical: boolean
    verticalAlign: string
    viewNode: Node
    whitespace: Vtree.Whitespace

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods