# `DimensionOptions`

> Contract 2.0.0 · package sha256 `a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e` · generated from `configurator-runtime.d.ts` by `services/onsite-scripter/scripts/build-contract-docs.mjs`; edit the source, not this file.

Interface · `import type { DimensionOptions } from '@holostep-configurators/runtime-client/contract';` · stable · since 2.0.0 · section 13. Overlays

What [`overlays.dimensions`](Overlays.dimensions.md) takes.

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="per"></a>[`per?`](DimensionOptions.per.md) | property | 'part': one ruler set per matched part. |
| <a id="axes"></a>[`axes?`](DimensionOptions.axes.md) | property | The rulers drawn: 'width' measures the bounds' world X extent, 'height' Y and 'depth' Z. |
| <a id="format"></a>[`format?`](DimensionOptions.format.md) | property | A format, or a function from metres to label text. |

## Declaration

```ts
export interface DimensionOptions {
  per?: 'all' | 'part' | 'node';
  axes?: ReadonlyArray<'width' | 'height' | 'depth'>;
  format?: DimensionFormat | ((metres: number, axis: 'width' | 'height' | 'depth') => string);
}
```

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `DimensionOptions` names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | not recorded: no ledger row names this member or its owner |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |