Skip to content
Shapemetry

Model - Render views

API reference for src/schema/renderViews, src/lanes/views/renderViews on @huukhanhnguyen/model, reachable from ..

See the Guide for the ModelJSON / evaluate pipeline.

API reference

Signatures are generated from the live package .d.ts - not hand-written.

RenderedViews

type

type RenderedViews
// = {
    width: number;
    height: number;
    /** RGBA, row-major, top-left origin. */
    pixels: Uint8ClampedArray;
    /** Tile rectangles in the montage, for tests and tooling. */
    tiles: Array<{
        label: string;
        x: number;
        y: number;
        width: number;
        height: number;
    }>;
}

renderViews

function

Render the model into one labeled montage: 8 whole-model views on top, then one isometric tile per visible group. Deterministic: same document + params → identical pixels.

renderViews(json: ModelJSON, options: { registry: Registry; params?: Record<string, unknown>; viewSize?: number; tileSize?: number; }): RenderedViews
Last updated: 📖 1 min readEdit on GitHub