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

    Interface ImageNode

    Renders images with configurable sizing, positioning, and effects. Supports object-fit modes, positioning, border radius, and saturation filters.

    interface ImageNode {
        backgroundBitmap: Image | null;
        children: BoxNode[];
        initialProps: Partial<BoxProps>;
        key?: string;
        name?: string;
        node: Node;
        props: ImageProps & BaseProps;
        _renderContent(
            ctx: CanvasRenderingContext2D,
            x: number,
            y: number,
            width: number,
            height: number,
        ): Promise<void>;
        appendChild(child: BoxNode, index: number): void;
        applyDefaults(): void;
        blendMode(): string;
        filterChain(): string;
        finalizeLayout(): boolean;
        getLoadingPromise(): Promise<void>;
        inkOverflow(): number;
        load(cache?: RenderImageCache, diskCacheKeys?: Set<string>): Promise<void>;
        loadBackgroundImage(
            cache?: RenderImageCache,
            diskCacheKeys?: Set<string>,
        ): Promise<void>;
        processInitialChildren(): void;
        render(
            ctx: CanvasRenderingContext2D,
            offsetX?: number,
            offsetY?: number,
        ): Promise<void>;
        resolveInheritedStyles(parentProps: BoxProps & BaseProps): void;
        setLayout(props: BoxProps): void;
        setPageTime(seconds: number): void;
        updateLayoutBasedOnComputedSize(): void;
    }

    Hierarchy (View Summary)

    Index
    backgroundBitmap children initialProps key? name? node props
    _renderContent appendChild applyDefaults blendMode filterChain finalizeLayout getLoadingPromise inkOverflow load loadBackgroundImage processInitialChildren render resolveInheritedStyles setLayout setPageTime updateLayoutBasedOnComputedSize
    backgroundBitmap: Image | null = null

    The decoded background picture, once the render's load pass has fetched it.

    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: ImageProps & BaseProps

    Current props including defaults and inherited values.

    Protected_renderContent

    • The blend mode this node composites with, or an empty string for the ordinary source-over.

      normal is the default and means exactly source-over, so it is not worth an offscreen.

      Returns string

    • The CSS filter chain this node draws through, or an empty string for none.

      saturate came first and stays a shorthand for the same machinery, so it leads the chain and filter follows — the order they would appear in if the shorthand were written out.

      Returns string

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

      Returns boolean

      Whether any node was marked as dirty during finalization.

    • The in-flight load, starting one if nothing has asked yet.

      Returns Promise<void>

    • How far this node's own drawing reaches past its box, beyond what its box model accounts for.

      Zero for a box, which paints within its bounds; TextNode overrides it, since a line too long for its box still draws unless something clips it. Used to size a group's offscreen, where anything unaccounted for is cut off at a hard edge.

      Returns number

    • Fetches and decodes the source, then tells Yoga what proportions it has.

      cache is scoped to one render, so the same URL appearing on several nodes is fetched once. Safe to call more than once: the first call's promise is returned again rather than a second fetch being started.

      Parameters

      Returns Promise<void>

    • Fetches this node's background picture, if it has one.

      Runs in the same pass as the images, before layout, and through the same cache — so a picture used as one node's background and another's image is fetched once. A failure leaves the node without a picture rather than failing the render, which is what a missing background should do.

      Parameters

      Returns Promise<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>

    • Tells this node which moment of the render it is being drawn for.

      Parameters

      • seconds: number

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods