API Reference

A detailed reference of available methods is provided in this section. The API is continuously evolving -new methods and features will be added over time. For specific use cases or requests, contact a Vectary customer success manager.

Name	Documented in	Snippet / Sandbox
init	Quick Start	Init
isReady	Quick Start	Init
postViewData	Quick Start	Init
dispatchEvent	Events & Listeners	dispatchEvent dispatchEvent
addEventListener	Events & Listeners	add-removeEventListener
removeEventListener	Events & Listeners	add-removeEventListener
setConfigurationState	Floating UI	get-setConfigurationState
getConfigurationState	Floating UI	get-setConfigurationState
getObjects		getObjects
getHoveredObjects		Transformations
duplicateObjects		duplicateObjects
moveObjects		moveObjects
getPosition		Transformations
setPosition		Transformations
getRotation		Transformations
setRotation		Transformations
getScale		Transformations
setScale		Transformations
getPrimitives		get-setPrimitives
setPrimitives		get-setPrimitives
getText3d		get-setText3d
setText3d		get-setText3d
getAllMaterials		getAllMaterials
getMaterials		getMaterials
getActiveMaterial		get-setActiveMaterial
setActiveMaterial		get-setActiveMaterial
addOrEditMaterial		addOrEditMaterial
removeMaterial		removeMaterial
getTextureData		get-setTextureData
setTextureData		get-setTextureData
addTexture		add-mapTextures
mapTextures		add-mapTextures
raycastAll		get-setTextureData
raycastObject		getRayFromCoordinate
getRayFromCoordinate		getRayFromCoordinate
getAnimations		Animation Player
playAnimation		Animation Player
stopAnimation		Animation Player
setAnimationPlayhead		Animation Player
rotateEnvironmentMap		rotateEnvironmentMap
getViewState		get-setViewState
setViewState		get-setViewState
fitToView		fitToView
takeScreenshot		takeScreenshot
importFiles		importFiles
importProject		importProject
exportFile		exportFile