TitleblockRegistry

A sheet names a template by its id and gives the field values.

Import

import {
  TitleblockRegistry,
  resolveTitleblock,
  DEFAULT_TITLEBLOCK_ID,
  DEFAULT_TITLEBLOCK_TEMPLATE,
} from '@opengeometry/floorkit';

Example

import {
  TitleblockRegistry,
  DEFAULT_TITLEBLOCK_ID,
  DEFAULT_TITLEBLOCK_TEMPLATE,
} from '@opengeometry/floorkit';

const templates = new TitleblockRegistry();
const standard = templates.get(DEFAULT_TITLEBLOCK_ID);
const custom = { ...DEFAULT_TITLEBLOCK_TEMPLATE, id: 'office-titleblock' };
templates.register(custom);
console.log(standard, templates.get('office-titleblock'));

Notes

The default template is registered, unless seedDefault is false.
register() replaces a template that has the same id.
get() returns undefined for an unknown id.
Template geometry is in paper millimetres.
The registry is not saved in the project file. Give it again when you export, through the templates option.

Inheritance: implements TitleblockTemplateRegistry

Constructor

constructor(seedDefault?: boolean);

Methods

register

register(template: TitleblockTemplate): void;

get

get(id: string): TitleblockTemplate | undefined;

resolveTitleblock

Resolve a template + instance + context to absolute paper-mm drawables.

function resolveTitleblock(
  template: TitleblockTemplate,
  instance: TitleblockInstance,
  context: TitleblockContext,
): ResolvedTitleblock;

DEFAULT_TITLEBLOCK_ID

const DEFAULT_TITLEBLOCK_ID = 'default';

DEFAULT_TITLEBLOCK_TEMPLATE

A bottom-right A-series title block that works out of the box: project name, sheet name, an editable sheet number, ISO date, scale, and page x/of y.

const DEFAULT_TITLEBLOCK_TEMPLATE: TitleblockTemplate;

Types

TitleblockTemplateRegistry

The package does not export this type by name.

interface TitleblockTemplateRegistry {
  register(template: TitleblockTemplate): void;
  get(id: string): TitleblockTemplate | undefined;
}

TitleblockTemplate

A reusable title-block: static graphics + named fields, authored once and placed via a TitleblockInstance (.spec/debt.md “Paper / drawing layer”).

interface TitleblockTemplate {
  id: string;
  name: string;
  size: {
    width: number;
    height: number;
  };
  anchor: 'bottom-right' | 'bottom' | 'right' | 'top' | 'free';
  origin?: {
    x: number;
    y: number;
  };
  elements: TitleblockElement[];
}

string

required

string

required

{ width: number; height: number; }

required

Block size in paper units (mm).

"bottom-right" | "bottom" | "right" | "top" | "free"

required

{ x: number; y: number; }

Absolute paper-mm origin, for anchor: "free". Ignored otherwise.

TitleblockElement[]

required

TitleblockContext

Inputs used to compute auto-fields when resolving a title block. The package does not export this type by name.

interface TitleblockContext {
  page: PageSpec;
  sheetName: string;
  projectName?: string;
  pageNumber?: number;
  pageCount?: number;
  scale?: string;
  date?: string;
}

PageSpec

required

string

required

string

number

string

Pre-formatted scale label, e.g. “1:50”.

string

ISO date (YYYY-MM-DD). Defaults to today.

ResolvedTitleblock

A title block resolved to absolute paper-mm drawables. The package does not export this type by name.

interface ResolvedTitleblock {
  statics: ResolvedStatic[];
  texts: ResolvedText[];
}

TitleblockElement

type TitleblockElement = TitleblockStatic | TitleblockField;

ResolvedStatic

The package does not export this type by name.

interface ResolvedStatic {
  kind: 'line' | 'rect' | 'image';
  rect: Rect;
  stroke?: string;
  fill?: string;
  src?: string;
}

ResolvedText

The package does not export this type by name.

interface ResolvedText {
  text: string;
  rect: Rect;
  fontSize: number;
  align: 'left' | 'center' | 'right';
}

TitleblockStatic

The package does not export this type by name.

interface TitleblockStatic {
  kind: 'line' | 'rect' | 'image';
  rect: Rect;
  stroke?: string;
  fill?: string;
  src?: string;
}

"line" | "rect" | "image"

required

Rect

required

Relative to the block origin (top-left). line runs corner→corner.

string

TitleblockField

The package does not export this type by name.

interface TitleblockField {
  kind: 'field';
  name: string;
  auto?: TitleblockAutoField;
  rect: Rect;
  fontSize: number;
  align?: 'left' | 'center' | 'right';
  label?: string;
}

"field"

required

string

required

Bound by name from TitleblockInstance.values, unless auto is set.

TitleblockAutoField

Rect

required

Relative to the block origin (top-left).

number

required

"left" | "center" | "right"

string

Optional caption drawn before the value.

Rect

Rectangle in paper units (mm). The package does not export this type by name.

interface Rect {
  x: number;
  y: number;
  width: number;
  height: number;
}

TitleblockAutoField

The package does not export this type by name.

type TitleblockAutoField =
  | 'pageNumber'
  | 'pageCount'
  | 'date'
  | 'scale'
  | 'sheetName'
  | 'projectName';

API Reference

Runtime

Primitives

Shapes

Architecture

Datums

Annotations

Drawings

Views

World

Exports

Editor

Integration

Licensing

TitleblockRegistry

Import

Example

Notes

Constructor

Methods

register

get

resolveTitleblock

DEFAULT_TITLEBLOCK_ID

DEFAULT_TITLEBLOCK_TEMPLATE

Types

TitleblockTemplateRegistry

TitleblockTemplate

TitleblockContext

ResolvedTitleblock

TitleblockElement

ResolvedStatic

ResolvedText

TitleblockStatic

TitleblockField

Rect

TitleblockAutoField

​Import

​Example

​Notes

​Constructor

​Methods

​register

​get

​resolveTitleblock

​DEFAULT_TITLEBLOCK_ID

​DEFAULT_TITLEBLOCK_TEMPLATE

​Types

​TitleblockTemplateRegistry

​TitleblockTemplate

​TitleblockContext

​ResolvedTitleblock

​TitleblockElement

​ResolvedStatic

​ResolvedText

​TitleblockStatic

​TitleblockField

​Rect

​TitleblockAutoField

​Related

Import

Example

Notes

Constructor

Methods

register

get

resolveTitleblock

DEFAULT_TITLEBLOCK_ID

DEFAULT_TITLEBLOCK_TEMPLATE

Types

TitleblockTemplateRegistry

TitleblockTemplate

TitleblockContext

ResolvedTitleblock

TitleblockElement

ResolvedStatic

ResolvedText

TitleblockStatic

TitleblockField

Rect

TitleblockAutoField

Related