DIQ_Project

Last updated 18/02/2026

Purpose

The

DIQ_Project

type represents a top-level container within DimensionIQ. It defines the primary grouping structure for all project-related data including drawings, layouts, dimensions, and dimension groups.

A

DIQ_Project

serves as the root organizational entity for measurement data and provides the contextual identity under which all related objects operate.

This type is commonly used when:

• Creating or loading a project
• Displaying project metadata
• Persisting project-level information
• Associating drawings and measurements to a specific job or client

By standardizing project structure into a defined type, DimensionIQ ensures consistency in how projects are created, stored, retrieved, and displayed across host applications.

Why This Type Exists

DimensionIQ manages hierarchical measurement data. At the highest level of that hierarchy is the Project.

The

DIQ_Project

type exists to:

• Provide a consistent identity for measurement collections
• Support grouping of drawings and dimensions under a single context
• Allow host systems to attach business metadata (eg job numbers, references, etc)
• Maintain measurement system settings at a project-level
• Ensure predictable serialization and persistence

Because the DimensionIQWidget does not control business-specific project storage, the host application is responsible for managing project data.

DIQ_Project

provides a structured contract to make the integration reliable and predictable.

Properties

Properties	Type	Required	Description
key	string	Yes	Unique identifier for the project, used internally for referencing and persistence
name	string	Yes	Display name of the project shown in the UI
code	string	No	Optional business-specific reference such as job number or project code
measurementSystem	string	Yes	Defines the unit system used within the project (eg, metric or imperial)
notes	string	No	Optional free-text notes or description associated with the project

Behavioral Expectations

Project Identity

• The
  key
  must be unique within the host application
• The
  key
  should remain stable once created
• Changing the key may break references to associated drawings or dimensions

Display Behavior

• name
  is the primary user-facing identifier
• code
  may be displayed alongside the name depending on host application
• notes
  may be shown in project summaries or detail views

Measurement System

• measurementSystem
  determines how dimensions are interpreted and displayed
• The host application should ensure compatibility between stored measurements and the defined system
• Changing the measurement system after dimensions exist may require conversion logic handled by the host

Summary

DIQ_Project

is the foundational container within DimensionIQ. It defines the identity, configuration, and metadata for a measurement project and acts as the root context for all related data structures.

By enforcing a structured project model, DimensionIQ ensures consistent organization, reliable persistence, and predictable integration behavior across host applications.