DIQ_Dimension

Last updated 20/07/2026

Overview

The

DIQ_Dimension

type represents a single measured entity created within a DimensionIQ layout.

It contains the geometry, calculated measurement values, metadata, and relational references required for DimensionIQ to display, maintain, and synchronize individual measurements within a project.

DIQ_Dimension

objects are created and managed by DimensionIQ. The values provided within the object are generated by DimensionIQ and should be treated as read-only by the host application.

The host application is responsible for persisting

DIQ_Dimension

records within its preferred storage system, such as a database, file storage, or object storage service. When DimensionIQ creates a new dimension, the complete

DIQ_Dimension

object is provided through the

onDimensionsNew

> event and should be stored by the host application.

When DimensionIQ updates an existing dimension, the updated

DIQ_Dimension

object is provided through the

onDimensionUpdate

> event or the

onDimensionsUpdate

> event. The host application should update its stored record using the values supplied by DimensionIQ.

The host application may use the persisted

DIQ_Dimension

data for its own business workflows, including cost analysis, quantity calculations, estimating, reporting, and other application-specific processes.

Properties

Property	Type	Required	Description
key	string	Yes	Unique identifier for the dimension
groupKey	string	Yes	References the dimension group this dimension belongs to
layoutKey	string	Yes	References the layout where the dimension was created
name	string	Yes	User-defined label for the dimension
state	string	Yes	Lifecycle state of the dimension (eg, new, updated, deleted, unchanged)
type	string	Yes	Measurement type (eg, length, area, volume, count)
count	number	Yes	Number of measured items
height	number	No	Height used in calculations, typically for vertical or volumetric measurements
offset	number	No	Elevation offset applied to the dimension
length	number	No	Calculated horizontal length
elevatedLength	number	No	Length adjusted for elevation or slope
area	number	No	Calculated surface area
verticalArea	number	No	Calculated vertical area, such as wall face area
volume	number	No	Calculated volume
weight	number	No	Calculated or derived weight
bimID	string	No	Identifier linking this dimension to a BIM element
drawingObject	string	Yes	Serialized representation of the graphical object in the drawing
notes	string	No	Optional free text notes associated with the dimension
zone1Key	string	No	References the selected value in the project's first dimension zone group
zone2Key	string	No	References the selected value in the project's second dimension zone group
zone3Key	string	No	References the selected value in the project's third dimension zone group
zone4Key	string	No	References the selected value in the project's fourth dimension zone group

Implementation Guidelines

Data Persistence

DIQ_Dimension

objects should be persisted by the host application exactly as provided by DimensionIQ.

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 host application.

The host application should not create, calculate, or populate

DIQ_Dimension

values. DimensionIQ is responsible for generating and maintaining all measurement related data required for DimensionIQ functionality.

When the

onDimensionsNew

> event is received, the host application should store the provided

DIQ_Dimension

object.

When the

onDimensionUpdate

> or

onDimensionsUpdate

> events are received, the host application should update the existing stored

DIQ_Dimension

record with the updated object provided by DimensionIQ.

Measurement Data Usage

Measurement values within

DIQ_Dimension

are calculated by DimensionIQ and should be treated as authoritative outputs.

Properties such as

length

,

elevatedLength

,

area

,

verticalArea

,

volume

,

weight

, and

count

may be consumed by the host application for downstream workflows including costing, estimating, reporting, analytics, and quantity tracking.

The host application may combine these values with its own business data, such as rates, pricing information, or project metadata, to generate application-specific outputs.

Geometry and References

The

drawingObject

property contains the serialized geometry representation created by DimensionIQ and should be persisted without modification.

Relationship properties including

groupKey

,

layoutKey

,

bimID

, and zone keys should also be stored as provided by DimensionIQ to preserve the relationship between the dimension and associated project data.

These values are required by DimensionIQ when retrieving, synchronizing, or displaying measurement information.

Read-Only Behavior

All

DIQ_Dimension

properties should be considered read-only from the perspective of the host application.

The host application may read and use the values for its own workflows but should not modify measurement geometry, calculated values, identifiers, or DimensionIQ-managed metadata.

Any changes to a dimension should be performed through DimensionIQ, which will then provide the updated

DIQ_Dimension

object through the appropriate event.