Skip to main content

See My Model Api

API

<see-my-model-button>

SeeMyModel Button element that enables users to view models from api.seemymodel.com in AR mode.

Attributes

NameDescriptionTypeDefault
access-keyID of the arModelstring""
model-access-keyID of the arModelstring""
ar-placementPlacement of the model when ar mode is activated, default: floor"floor" | "wall""floor"
disable-occlusionSet to true to disable occlusion in AR on Android SceneViewerbooleanfalse
localeComponent's language, default: `auto`, possible values: `auto`, `en`, `pl`. `auto` detects user browser's language and sets its langauge if supported, `en` otherwisestring"auto"

Properties

NameAttributeDescriptionTypeDefault
legacyAccessKeyAttributeaccess-keyID of the arModelstring""
modelAccessKeymodel-access-keyID of the arModelstring""
arPlacementar-placementPlacement of the model when ar mode is activated, default: floor"floor" | "wall""floor"
disableOcclusiondisable-occlusionSet to true to disable occlusion in AR on Android SceneViewerbooleanfalse
localelocaleComponent's language, default: `auto`, possible values: `auto`, `en`, `pl`. `auto` detects user browser's language and sets its langauge if supported, `en` otherwisestring"auto"

Slots

NameDescription
ar-buttonUse this slot to implement custom AR Button.

<see-my-model-group>

SeeMyModel element that shows group of models from api.seemymodel.com in 3D Viewer in browser and in AR mode.

Attributes

NameDescriptionTypeDefault
folder-access-keyID of the group folderstring""
model-access-keyID of the model in the group that should be presented at first positionstring""
ar-placementPlacement of the model when ar mode is activated, default: floor"floor" | "wall""floor"
disable-occlusionSet to true to disable occlusion in AR on Android SceneViewerbooleanfalse
auto-run-arundefinedbooleanfalse
touch-actionSpecifies in which axis element can be scrolled with touch controls: - pan-y - touch user can vertically scroll element, starting gesture in horizontal axis results in interaction with the model; - pan-x - opossite of pan-y; - none - element cannot be scrolled by touch gestures;"pan-y" | "pan-x" | "none""none"
auto-rotateEnables auto rotationbooleanfalse
auto-rotate-delayNumber in ms after which object starts to rotate, measured from last user interactionnumber3000
rotation-per-secondAuto rotation speed, in radians, degress or percents (100% is equal to pi/32 radians), e.g. "90deg", "0.25rad", "500%"string"100%"
interaction-promptSpecifies when interaction prompt should be visible: - auto - after time set via interaction-prompt-threshold has elapsed; - when-focused - same as auto but an element must have received focus first; - none - never;"none" | "auto""auto"
interaction-prompt-thresholdSpecifies how long element should wait before showing interaction-promptnumber3000
camera-orbitOrbital position of the camera in form: "theta phi radius" - theta - polar angle in radians "rad" or degrees "deg", or "auto" which equals to 0deg; - phi - azimuthal angle in radians "rad" or degrees "deg", or auto which equals to 75deg; - radius - distance from target in meters "m", centimeters "cm", millimeters "mm" or percentages "%" (100% should fit the model inside the viewer) or "auto" which equals to "105%"; Every property also accepts css functions: calc() and env()string"auto auto auto"
camera-targetPoint that camera orbits around in form: "X Y Z". Each value should be specified in meters "m", centimeters "cm" or millimeters "mm". Each value can also accept "auto" which is equal to the center of the model bounding boxstring"auto auto auto"
max-camera-orbitMaximum values for the camera-orbitstring"Infinity 180deg 300%"
min-camera-orbitMinimum values for the camera-orbitstring"-Infinity 0deg auto"
field-of-viewVertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg". Must be in range (0deg, 180deg)string"auto"
max-field-of-viewMaximum vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg". Must be in range (0deg, 180deg)string"auto"
min-field-of-viewMinimum vertical field of view of the camera in degress "deg" or radians "rad". Must be in range (0deg, 180deg)string"auto"
disable-panning-cameraDisable ability for user to pan the camera around with Right Mouse Button or with two fingers on touch devicesbooleanfalse
tutorial-modeSpecifies when tutorial should be visible"onFirstVisit" | "always" | "never"undefined
preview-modeOptional, set it to run viewer in 'preview-mode` in which viewer simulates being run on selected platform WARNING: in `preview-mode` augmented reality functionality is disabled"pc" | "mobile"undefined
ar-button-colorOptional, choose custom ar button color, in hex format e.g. "#ffffff"stringundefined
show-posterOptional, whether to show poster before model loadsbooleanundefined
reveal-modeOptional, reveal mode - `auto` - model loads immiedietely when component is in view and shows as soon as possible - `interaction` - model loads when user clicks on component - `interactionWithPreload` - model loads immiedietely when componenent is in view but shows only after user clicks on component"auto" | "interaction" | "interactionWithPreload"undefined
skybox-imageOptional, url to skybox hdr imagestringundefined
environment-imageOptional, url to skybox hdr imagestringundefined
disable-external-configurationSet to true to disable configuration via remote REST APIbooleanfalse
localeComponent's language, default: `auto`, possible values: `auto`, `en`, `pl`. `auto` detects user browser's language and sets its langauge if supported, `en` otherwisestring"auto"

Properties

NameAttributeDescriptionTypeDefault
folderAccessKeyfolder-access-keyID of the group folderstring""
modelAccessKeymodel-access-keyID of the model in the group that should be presented at first positionstring""
arPlacementar-placementPlacement of the model when ar mode is activated, default: floor"floor" | "wall""floor"
disableOcclusiondisable-occlusionSet to true to disable occlusion in AR on Android SceneViewerbooleanfalse
autoRunARauto-run-arundefinedbooleanfalse
touchActiontouch-actionSpecifies in which axis element can be scrolled with touch controls: - pan-y - touch user can vertically scroll element, starting gesture in horizontal axis results in interaction with the model; - pan-x - opossite of pan-y; - none - element cannot be scrolled by touch gestures;"pan-y" | "pan-x" | "none""none"
autoRotateauto-rotateEnables auto rotationbooleanfalse
autoRotateDelayauto-rotate-delayNumber in ms after which object starts to rotate, measured from last user interactionnumber3000
rotationPerSecondrotation-per-secondAuto rotation speed, in radians, degress or percents (100% is equal to pi/32 radians), e.g. "90deg", "0.25rad", "500%"string"100%"
interactionPromptinteraction-promptSpecifies when interaction prompt should be visible: - auto - after time set via interaction-prompt-threshold has elapsed; - when-focused - same as auto but an element must have received focus first; - none - never;"none" | "auto""auto"
interactionPromptThresholdinteraction-prompt-thresholdSpecifies how long element should wait before showing interaction-promptnumber3000
cameraOrbitcamera-orbitOrbital position of the camera in form: "theta phi radius" - theta - polar angle in radians "rad" or degrees "deg", or "auto" which equals to 0deg; - phi - azimuthal angle in radians "rad" or degrees "deg", or auto which equals to 75deg; - radius - distance from target in meters "m", centimeters "cm", millimeters "mm" or percentages "%" (100% should fit the model inside the viewer) or "auto" which equals to "105%"; Every property also accepts css functions: calc() and env()string"auto auto auto"
cameraTargetcamera-targetPoint that camera orbits around in form: "X Y Z". Each value should be specified in meters "m", centimeters "cm" or millimeters "mm". Each value can also accept "auto" which is equal to the center of the model bounding boxstring"auto auto auto"
maxCameraOrbitmax-camera-orbitMaximum values for the camera-orbitstring"Infinity 180deg 300%"
minCameraOrbitmin-camera-orbitMinimum values for the camera-orbitstring"-Infinity 0deg auto"
fieldOfViewfield-of-viewVertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg". Must be in range (0deg, 180deg)string"auto"
maxFieldOfViewmax-field-of-viewMaximum vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg". Must be in range (0deg, 180deg)string"auto"
minFieldOfViewmin-field-of-viewMinimum vertical field of view of the camera in degress "deg" or radians "rad". Must be in range (0deg, 180deg)string"auto"
disablePanningCameradisable-panning-cameraDisable ability for user to pan the camera around with Right Mouse Button or with two fingers on touch devicesbooleanfalse
stylesundefinedundefinedCSSResult"style"
tutorialModetutorial-modeSpecifies when tutorial should be visible"onFirstVisit" | "always" | "never"undefined
isTutorialDialogVisibleundefinedundefinedbooleanundefined
previewModepreview-modeOptional, set it to run viewer in 'preview-mode` in which viewer simulates being run on selected platform WARNING: in `preview-mode` augmented reality functionality is disabled"pc" | "mobile"undefined
arButtonColorar-button-colorOptional, choose custom ar button color, in hex format e.g. "#ffffff"stringundefined
showPostershow-posterOptional, whether to show poster before model loadsbooleanundefined
revealModereveal-modeOptional, reveal mode - `auto` - model loads immiedietely when component is in view and shows as soon as possible - `interaction` - model loads when user clicks on component - `interactionWithPreload` - model loads immiedietely when componenent is in view but shows only after user clicks on component"auto" | "interaction" | "interactionWithPreload"undefined
skyboxImageskybox-imageOptional, url to skybox hdr imagestringundefined
environmentImageenvironment-imageOptional, url to skybox hdr imagestringundefined
disableExternalConfigurationdisable-external-configurationSet to true to disable configuration via remote REST APIbooleanfalse
localelocaleComponent's language, default: `auto`, possible values: `auto`, `en`, `pl`. `auto` detects user browser's language and sets its langauge if supported, `en` otherwisestring"auto"

Slots

NameDescription
ar-buttonUse this slot to implement custom AR Button.

<see-my-model>

SeeMyModel element that shows models from api.seemymodel.com in 3D Viewer in browser and in AR mode.

Attributes

NameDescriptionTypeDefault
access-keyID of the arModelstring""
model-access-keyID of the arModelstring""
ar-placementPlacement of the model when ar mode is activated, default: floor"floor" | "wall""floor"
disable-occlusionSet to true to disable occlusion in AR on Android SceneViewerbooleanfalse
auto-run-arundefinedbooleanfalse
touch-actionSpecifies in which axis element can be scrolled with touch controls: - pan-y - touch user can vertically scroll element, starting gesture in horizontal axis results in interaction with the model; - pan-x - opossite of pan-y; - none - element cannot be scrolled by touch gestures;"pan-y" | "pan-x" | "none""none"
auto-rotateEnables auto rotationbooleanfalse
auto-rotate-delayNumber in ms after which object starts to rotate, measured from last user interactionnumber3000
rotation-per-secondAuto rotation speed, in radians, degress or percents (100% is equal to pi/32 radians), e.g. "90deg", "0.25rad", "500%"string"100%"
interaction-promptSpecifies when interaction prompt should be visible: - auto - after time set via interaction-prompt-threshold has elapsed; - when-focused - same as auto but an element must have received focus first; - none - never;"none" | "auto""auto"
interaction-prompt-thresholdSpecifies how long element should wait before showing interaction-promptnumber3000
camera-orbitOrbital position of the camera in form: "theta phi radius" - theta - polar angle in radians "rad" or degrees "deg", or "auto" which equals to 0deg; - phi - azimuthal angle in radians "rad" or degrees "deg", or auto which equals to 75deg; - radius - distance from target in meters "m", centimeters "cm", millimeters "mm" or percentages "%" (100% should fit the model inside the viewer) or "auto" which equals to "105%"; Every property also accepts css functions: calc() and env()string"auto auto auto"
camera-targetPoint that camera orbits around in form: "X Y Z". Each value should be specified in meters "m", centimeters "cm" or millimeters "mm". Each value can also accept "auto" which is equal to the center of the model bounding boxstring"auto auto auto"
max-camera-orbitMaximum values for the camera-orbitstring"Infinity 180deg 300%"
min-camera-orbitMinimum values for the camera-orbitstring"-Infinity 0deg auto"
field-of-viewVertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg". Must be in range (0deg, 180deg)string"auto"
max-field-of-viewMaximum vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg". Must be in range (0deg, 180deg)string"auto"
min-field-of-viewMinimum vertical field of view of the camera in degress "deg" or radians "rad". Must be in range (0deg, 180deg)string"auto"
disable-panning-cameraDisable ability for user to pan the camera around with Right Mouse Button or with two fingers on touch devicesbooleanfalse
tutorial-modeSpecifies when tutorial should be visible"onFirstVisit" | "always" | "never"undefined
preview-modeOptional, set it to run viewer in 'preview-mode` in which viewer simulates being run on selected platform WARNING: in `preview-mode` augmented reality functionality is disabled"pc" | "mobile"undefined
ar-button-colorOptional, choose custom ar button color, in hex format e.g. "#ffffff"stringundefined
show-posterOptional, whether to show poster before model loadsbooleanundefined
reveal-modeOptional, reveal mode - `auto` - model loads immiedietely when component is in view and shows as soon as possible - `interaction` - model loads when user clicks on component - `interactionWithPreload` - model loads immiedietely when componenent is in view but shows only after user clicks on component"auto" | "interaction" | "interactionWithPreload"undefined
skybox-imageOptional, url to skybox hdr imagestringundefined
environment-imageOptional, url to skybox hdr imagestringundefined
disable-external-configurationSet to true to disable configuration via remote REST APIbooleanfalse
localeComponent's language, default: `auto`, possible values: `auto`, `en`, `pl`. `auto` detects user browser's language and sets its langauge if supported, `en` otherwisestring"auto"

Properties

NameAttributeDescriptionTypeDefault
legacyAccessKeyAttributeaccess-keyID of the arModelstring""
modelAccessKeymodel-access-keyID of the arModelstring""
arPlacementar-placementPlacement of the model when ar mode is activated, default: floor"floor" | "wall""floor"
disableOcclusiondisable-occlusionSet to true to disable occlusion in AR on Android SceneViewerbooleanfalse
autoRunARauto-run-arundefinedbooleanfalse
touchActiontouch-actionSpecifies in which axis element can be scrolled with touch controls: - pan-y - touch user can vertically scroll element, starting gesture in horizontal axis results in interaction with the model; - pan-x - opossite of pan-y; - none - element cannot be scrolled by touch gestures;"pan-y" | "pan-x" | "none""none"
autoRotateauto-rotateEnables auto rotationbooleanfalse
autoRotateDelayauto-rotate-delayNumber in ms after which object starts to rotate, measured from last user interactionnumber3000
rotationPerSecondrotation-per-secondAuto rotation speed, in radians, degress or percents (100% is equal to pi/32 radians), e.g. "90deg", "0.25rad", "500%"string"100%"
interactionPromptinteraction-promptSpecifies when interaction prompt should be visible: - auto - after time set via interaction-prompt-threshold has elapsed; - when-focused - same as auto but an element must have received focus first; - none - never;"none" | "auto""auto"
interactionPromptThresholdinteraction-prompt-thresholdSpecifies how long element should wait before showing interaction-promptnumber3000
cameraOrbitcamera-orbitOrbital position of the camera in form: "theta phi radius" - theta - polar angle in radians "rad" or degrees "deg", or "auto" which equals to 0deg; - phi - azimuthal angle in radians "rad" or degrees "deg", or auto which equals to 75deg; - radius - distance from target in meters "m", centimeters "cm", millimeters "mm" or percentages "%" (100% should fit the model inside the viewer) or "auto" which equals to "105%"; Every property also accepts css functions: calc() and env()string"auto auto auto"
cameraTargetcamera-targetPoint that camera orbits around in form: "X Y Z". Each value should be specified in meters "m", centimeters "cm" or millimeters "mm". Each value can also accept "auto" which is equal to the center of the model bounding boxstring"auto auto auto"
maxCameraOrbitmax-camera-orbitMaximum values for the camera-orbitstring"Infinity 180deg 300%"
minCameraOrbitmin-camera-orbitMinimum values for the camera-orbitstring"-Infinity 0deg auto"
fieldOfViewfield-of-viewVertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg". Must be in range (0deg, 180deg)string"auto"
maxFieldOfViewmax-field-of-viewMaximum vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg". Must be in range (0deg, 180deg)string"auto"
minFieldOfViewmin-field-of-viewMinimum vertical field of view of the camera in degress "deg" or radians "rad". Must be in range (0deg, 180deg)string"auto"
disablePanningCameradisable-panning-cameraDisable ability for user to pan the camera around with Right Mouse Button or with two fingers on touch devicesbooleanfalse
stylesundefinedundefinedCSSResult"style"
tutorialModetutorial-modeSpecifies when tutorial should be visible"onFirstVisit" | "always" | "never"undefined
isTutorialDialogVisibleundefinedundefinedbooleanundefined
previewModepreview-modeOptional, set it to run viewer in 'preview-mode` in which viewer simulates being run on selected platform WARNING: in `preview-mode` augmented reality functionality is disabled"pc" | "mobile"undefined
arButtonColorar-button-colorOptional, choose custom ar button color, in hex format e.g. "#ffffff"stringundefined
showPostershow-posterOptional, whether to show poster before model loadsbooleanundefined
revealModereveal-modeOptional, reveal mode - `auto` - model loads immiedietely when component is in view and shows as soon as possible - `interaction` - model loads when user clicks on component - `interactionWithPreload` - model loads immiedietely when componenent is in view but shows only after user clicks on component"auto" | "interaction" | "interactionWithPreload"undefined
skyboxImageskybox-imageOptional, url to skybox hdr imagestringundefined
environmentImageenvironment-imageOptional, url to skybox hdr imagestringundefined
disableExternalConfigurationdisable-external-configurationSet to true to disable configuration via remote REST APIbooleanfalse
localelocaleComponent's language, default: `auto`, possible values: `auto`, `en`, `pl`. `auto` detects user browser's language and sets its langauge if supported, `en` otherwisestring"auto"

Slots

NameDescription
ar-buttonUse this slot to implement custom AR Button.