Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Choose which labels a plan shows and keep them apart.
import {
filterRoomLabels,
tagOpenings,
declutterText,
ROOM_LABEL_NAME,
ROOM_LABEL_DETAIL,
} from '@opengeometry/floorkit';
function filterRoomLabels(
primitives: ReadonlyArray<DrawingPrimitive>,
mode?: RoomLabelMode,
): DrawingPrimitive[];
function tagOpenings(
primitives: DrawingPrimitive[],
mode?: OpeningTagMode,
{
labels,
heightM,
}?: {
labels?: Map<string, string>;
heightM?: number;
},
): DrawingPrimitive[];
function declutterText(primitives: ReadonlyArray<DrawingPrimitive>): DrawingPrimitive[];
style.subId values Space.toDrawing tags its two label lines with.
const ROOM_LABEL_NAME = 'label:name';
const ROOM_LABEL_DETAIL = 'label:detail';
full = name + number · area; name = name only; none = neither.
type RoomLabelMode = 'full' | 'name' | 'none';
type OpeningTagMode = 'none' | 'auto';