DIQ_Layout
Overview
The
It contains the measurement configuration, calibration settings, display preferences, and metadata required for DimensionIQ to measure a specific drawing page.
The host application is responsible for persisting
The host application may use the persisted layout data for application specific workflows including reporting, drawing management, project tracking, and integration with external document management or estimating systems.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Unique identifier for the layout |
drawingRevisionKey | string | Yes | References the parent DIQ_DrawingRevision |
ID | string | Yes | External or business-specific identifier for the layout |
name | string | Yes | Display name of the layout (eg, "Ground Floor Plan") |
UOM | string | Yes | Primary unit of measurement used in this layout |
bimLengthUOM | string | No | BIM-specific length unit |
bimAreaUOM | string | No | BIM-specific area unit |
bimVolumeUOM | string | No | BIM-specific volume unit |
bimWeightUOM | string | No | BIM-specific weight unit |
revisedState | string | No | Indicates the revision state of the layout (eg, Revising, Revised) |
locked | boolean | Yes | Indicates whether the layout is locked for measuring |
multiplier | number | Yes | Global measurement multiplier applied to dimensions |
xscale | number | Yes | X-axis scale factor |
yscale | number | Yes | Y-axis scale factor |
zscale | number | Yes | Z-axis scale factor (used for 3D/BIM scaling) |
xcalibration | number | Yes | X-axis calibration factor |
ycalibration | number | Yes | Y-axis calibration factor |
calibrationAngle | number | Yes | Rotation angle applied during calibration |
dimensionMode | string | Yes | Determines how dimensions behave (eg, 2D, BIM, scaled) |
backgroundColor | string | No | Layout background color setting |
showText | boolean | Yes | Controls visibility of dimension text |
showHatching | boolean | No | Controls display of hatch patterns |
warnMissingXRefs | boolean | Yes | Indicates whether missing external references should trigger warnings |
thumbnail | string | No | Encoded thumbnail preview of the layout |
extendedData | string | No | Internal use only |
TBTitle | string | No | Title block title value |
TBDrawingNumber | string | No | Title block drawing number |
TBRevision | string | No | Title block revision value |
TBDateReceived | string | No | Title block received date |
Implementation Guidelines
Data Persistence
The host application is responsible for selecting and maintaining its own storage mechanism. This may include relational databases, document databases, file storage, object storage, or any other persistence solution appropriate for the application.
The host application should not create, calculate, or modify
When a new
Measurement Configuration
Properties including
These values should be stored without modification to ensure the layout can be accurately reconstructed and measured when loaded by DimensionIQ.
Layout Relationships
The
The key property uniquely identifies the layout, while the ID property may be used as an external or business-specific identifier within the host application.
These relationships should be preserved to maintain the association between layouts and drawing revisions.
Layout Metadata
Properties such as
The host application may use these values for drawing management, reporting, document indexing, search, project tracking, or integration with external systems.
The
Display Configuration
Properties including
These values should be persisted exactly as supplied by DimensionIQ to ensure consistent behaviour across sessions and collaborative environments.
Read-Only Behavior
All
The host application may read and use the stored layout information for its own workflows but should not modify measurement configuration, calibration values, display settings, identifiers, or DimensionIQ managed metadata.
Any changes to a layout should be performed through DimensionIQ, which will provide the updated