meo-canvas - v8.0.1
    Preparing search index...

    Interface BoxNode

    BoxNode Base node class for rendering rectangular boxes with layout, styling, and children. It uses the Yoga layout engine for positioning and sizing.

    interface BoxNode {
        children: BoxNode[];
        initialProps: Partial<BoxProps>;
        key?: string;
        name?: string;
        node: Node;
        props: BoxProps & BaseProps;
        _renderContent(
            ctx: CanvasRenderingContext2D,
            x: number,
            y: number,
            width: number,
            height: number,
        ): Promise<void>;
        appendChild(child: BoxNode, index: number): void;
        applyDefaults(): void;
        finalizeLayout(): boolean;
        processInitialChildren(): void;
        render(
            ctx: CanvasRenderingContext2D,
            offsetX?: number,
            offsetY?: number,
        ): Promise<void>;
        resolveInheritedStyles(parentProps: BoxProps & BaseProps): void;
        setLayout(props: BoxProps): void;
        updateLayoutBasedOnComputedSize(): void;
    }

    Hierarchy (View Summary)

    Index
    children initialProps key? name? node props
    _renderContent appendChild applyDefaults finalizeLayout processInitialChildren render resolveInheritedStyles setLayout updateLayoutBasedOnComputedSize
    children: BoxNode[]

    Child nodes.

    initialProps: Partial<BoxProps>

    Original props passed to the constructor before any modifications.

    key?: string

    Unique node identifier.

    name?: string

    Node type name.

    node: Node

    The Yoga layout engine node.

    props: BoxProps & BaseProps

    Current props including defaults and inherited values.

    Protected_renderContent

    • _renderContent(
          ctx: CanvasRenderingContext2D,
          x: number,
          y: number,
          width: number,
          height: number,
      ): Promise<void>

      Renders the node's visual content including background fills, shadows, and borders. This is an internal method used by the render() pipeline.

      Parameters

      • ctx: CanvasRenderingContext2D

        The skia-canvas 2D rendering context to draw into

      • x: number

        The absolute x-coordinate where drawing should begin

      • y: number

        The absolute y-coordinate where drawing should begin

      • width: number

        The width of the content area to render

      • height: number

        The height of the content area to render

      Returns Promise<void>

    • Appends a child node at the specified index.

      Parameters

      • child: BoxNode

        Child node to append.

      • index: number

        Index to insert child at

      Returns void

    • Performs final layout adjustments recursively after the main layout calculation.

      Returns boolean

      Whether any node was marked as dirty during finalization.

    • Processes and appends any children passed in the initial props.

      Returns void

    • Draws this node, through its mask when it has one.

      Every component's drawing arrives here — Text, Image, Chart and Grid override _renderContent rather than this — so masking one node type means masking all of them.

      The two kinds of mask are applied differently because they are different operations. A shape or path clips, which is a yes-or-no test per pixel and costs nothing but a save/restore. A gradient cannot: its whole purpose is the answers in between, so the node is composited through one instead. Both are applied to the node's layout box, before its own transform, which is what keeps the two consistent with each other.

      dither is held on the context around all of it, so the node's mask, background, content and children are drawn with one answer and whatever draws next is left with its own.

      Parameters

      Returns Promise<void>

    • Hook for subclasses to update layout based on computed size.

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods