# `DimensionOptions.format`

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

Property of [`DimensionOptions`](DimensionOptions.md) · stable · since 2.0.0

```ts
format?: DimensionFormat | ((metres: number, axis: 'width' | 'height' | 'depth') => string);
```

A format, or a function from metres to label text.

**Default:** { unit: 'cm', decimals: 0 }

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `format` names no product |
| 2. A precedent | pass: [Intl.NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) (row `G14`); [Unity Renderer.bounds](https://docs.unity3d.com/ScriptReference/Renderer-bounds.html) (row `G14`); [Babylon.js GUI Control.linkWithMesh](https://github.com/BabylonJS/Babylon.js/blob/master/packages/dev/gui/src/2D/controls/control.ts) (row `K48`) |
| 3. Two apps, or labs | pass: 9 apps (ledger: app-4f16d2f6da, app-510d750508, app-b362a81c85, app-bcb7ef21da, app-ceb4eccc72, app-fb16dd1985, app-fc07850558, app-fc306ec3dc and 1 more) |
| 4. The cheaper fix first | decided per need in Appendix B: rows `G14`, `K48` at tier stable (a member only where no rule, data, asset or app code serves the need) |