DIQ_Project
Overview
The
DIQ_Project
type defines the root storage entity for a DimensionIQ project. It contains the project-level identity, metadata, and configuration
values required to associate and manage related measurement data, including drawings, layouts, dimensions, and dimension groups.
A
DIQ_Project
should be persisted by the host application as the parent record for all related DimensionIQ data.
Project management (see below) can also be controlled by the host application through the DimensionIQWidget properties
and capabilities.
DIQ_Project
stores project-wide configuration settings including the measurement system, default dimension group
colors, dimension zone group names used for categorizing dimensions, and whether the project can be used as a template when creating new projects.
The host application is responsible for creating, storing, retrieving, and maintaining
DIQ_Project
records when requested by DimensionIQ.
Properties
| Property | 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 measurement system used by DimensionIQ when displaying measurement values to the user (eg, metric or imperial) |
useAsTemplate | boolean | No | Indicates whether the project is available as a reusable template. projects marked as templates may be requested by DimensionIQ onListProjects when loading available templates |
notes | string | No | Optional free-text notes or description associated with the project |
defaultPositiveColor | string | No | Optional default color applied to new positive dimension groups created within the project |
defaultNegativeColor | string | No | Optional default color applied to new negative dimension groups created within the project |
zoneGroup1Name | string | No | Optional display name for the first dimension zone group, used to categorize dimensions within the project |
zoneGroup2Name | string | No | Optional display name for the second dimension zone group, used to categorize dimensions within the project |
zoneGroup3Name | string | No | Optional display name for the third dimension zone group, used to categorize dimensions within the project |
zoneGroup4Name | string | No | Optional display name for the fourth dimension zone group, used to categorize dimensions within the project |
Implementation Guidelines
Project Identity
The
key
property is the unique identifier for the project within the host application's storage system. It should remain unchanged after the project is created, as modifying
the key may invalidate relationships with associated drawings, layouts, dimensions, and dimension groups.
Metadata and Display
The
name
property should be treated as the primary user-facing identifier for the project. The optional code
property may be used by the host application as an external
business reference, such as a job number or project identifier. The optional notes
property provides additional project metadata and may be displayed within project details or
summary views.
Measurement System
The
measurementSystem
property defines the measurement system used in DimensionIQ when displaying measurement values to the user.
Project Templates
The
useAsTemplate
property indicates whether the project can be used as a template when creating new projects.
Default Measurement Colors
The
defaultPositiveColor
and defaultNegativeColor
properties define the default colors applied when creating new dimension
groups within the project.
These values are only applied during dimension group creation and should not automatically update existing dimension groups if the project defaults are changed.
If a default color is not provided, or is set to white (
#ffffff
), the dimension group dialog will automatically assign a random color to the
dimension group.
Dimension Zone Groups
The
zoneGroup1Name
through zoneGroup4Name
properties define the display names for the project's configurable dimension zone
groups.
These values provide the labels used when categorizing dimensions within the project and should be used by the host application when presenting dimension categorization options.
Project Management
Project management can be controlled by the host application through supported DimensionIQWidget properties
and capabilities.
See the DIQCapabilities chapter for details on implementing project management.