Codeboard.
Technical referenceAPI signaturesData shapes

Render types

Data shapes for render. See all type groups for other domains and shared units. Import public types from codeboard-studio; helper shapes are included to explain nested values.

CompositionGuides

Code
export interface CompositionGuides {
    frame?: number;
    thirds?: boolean;
    /** Fraction of frame width/height inset on each edge; not a broadcast standard. */
    safeInset?: number;
    /** Output-frame pixel coordinates, after camera placement. */
    horizonY?: number;
    vanishingPoints?: readonly {
        x: number;
        y: number;
    }[];
}

OnionSkinSample

Code
export interface OnionSkinSample {
    panelId: string;
    frame?: number;
    layerIds?: readonly string[];
    tint?: string;
    opacity?: number;
}

FontDependency

Code
export interface FontDependency {
    ownerId: string;
    layerId: string;
    elementId: string;
    font: string;
    canonicalFont: string | null;
    families: {
        name: string;
        status: "available" | "generic" | "missing";
    }[];
    resolvedFamilies: string[];
    issue: "invalid-declaration" | "unsupported-declaration" | "missing-family" | null;
}

FontInspection

Code
export interface FontInspection {
    available: boolean;
    elements: FontDependency[];
}

FontPolicy

Code
export type FontPolicy = "allow-fallback" | "require-available";

RenderSource

Code
export type RenderSource = StoryboardProject | StoryboardDocument;

PanelRenderSource

Code
export type PanelRenderSource = StoryboardProject | Pick<StoryboardDocument, "canvas" | "panels" | "shots">;

On this page