Types - Sheets#

API reference for ./evaluate/sheets on @huukhanhnguyen/types.

See the Guide for the package's role.

API reference#

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

LayoutSheet#

type

Declarative layout sheet — paper size + scale + evaluated title. No node parameters/operations. A host that authors sheets via a chain folds into this shape before persistence or export.

type LayoutSheet
// = {
    /** Sheet identifier / drawing number, e.g. "A-101". */
    key: string;
    /** Evaluated title-block name (plain string, not an expression). */
    title?: string;
    /** Paper width in millimetres. */
    paperWidth: number;
    /** Paper height in millimetres. */
    paperHeight: number;
    /** Drawing scale as model-mm per paper-mm (e.g. 100 for 1:100). */
    scale: number;
}

ResolvedSheet#

type

Resolved envelope for one drawing sheet.

type ResolvedSheet
// = {
    key: string;
    label?: string;
    value: ResolvedSheetValue;
}

ResolvedSheetValue#

type

Paper-space drawing value (paper mm, y-down, top-left origin).

type ResolvedSheetValue
// = {
    entities: Entity[];
    width: number;
    height: number;
    scaleLabel: string;
}

SheetSetEntry#

type

One page of a multi-sheet export set (SVG already serialized). key is the same drawing number Sheet.key / ResolvedSheet.key carry — the whole sheet family is keyed by one name. (The ISO 7200 title-block cell this value PRINTS into is still called "number"; that is a paper field, not a record key.)

type SheetSetEntry
// = {
    key: string;
    title: string;
    svg: string;
}