API Reference
JavaScript
Options and data attributes for the JavaScript package.
RoomViewerResourceType
type RoomViewerResourceType = 'poster' | 'carpet'RoomViewerDimensionUnit
type RoomViewerDimensionUnit = 'm' | 'cm' | 'in'RoomViewerDisplayUnit
type RoomViewerDisplayUnit = 'cm' | 'in'Options
Prop
Type
Data Attributes
| Attribute | Required | Default | Description |
|---|---|---|---|
data-neurodyn-room-viewer-dialog | No | - | Marks an element for the embed build. |
data-neurodyn-room-viewer-type | Yes | - | Resource display mode. Use poster or carpet. |
data-neurodyn-room-viewer-name | Yes | - | Title shown in the dialog header. |
data-neurodyn-room-viewer-src | No | - | Poster image URL. Used when type is poster. |
data-neurodyn-room-viewer-tinuuid | No | - | The object's tinuuid. Used when type is carpet. |
data-neurodyn-room-viewer-width | No | - | Poster width. Used when type is poster. |
data-neurodyn-room-viewer-height | No | - | Poster height. Used when type is poster. |
data-neurodyn-room-viewer-dimension-unit | No | m | Unit used by poster width and height. Use m, cm, or in. |
data-neurodyn-room-viewer-display-unit | No | cm | Unit used to display UI measurements. Use cm or in. |
data-neurodyn-room-viewer-language | No | User locale | UI language override. Use en or ru. |
data-neurodyn-room-viewer-api-key | No | - | Public API key sent as x-api-key. |
data-neurodyn-room-viewer-source | No | default | Backend source mode. Use default or shopify. |