3D Simple Renderer (Aura)

SimpleRenderer is our first component made strictly for natively rendering a 3D drawing file within Salesforce. Once loaded, the drawing takes center stage while allowing for users to interact by mouse.

Use the SimpleRenderer wherever you would use a product or component image. SimpleRenderer has no supported global methods, Although the SimpleRenderer is a global component, you likely want to develop with our AdvancedRenderer.

SimpleRenderer requires one of the following attributes in order to render a drawing on the screen:

NAME	TYPE	DEFAULT	DESCRIPTION
brandImageURL	string		URL for brand image to be displayed in the bottom right of the rendering canvas. This will be displayed at a width of 120px
contentVersionId	string		Id of the Salesforce Content Version where the binary rendering is stored
environmentColor	string	#e1f5fc	Hex code for the background color of the 3D scene in #xxxxxx format (including #)
overrideURL	string		URL where your drawing can be fetched (ignores underlying relationships)
recordId	string		Inherited from force:hasRecordId The record Id
showActionMenu	boolean	TRUE	Display the action menu to users, allowing for screenshots, changing of scene elements and more
showUserMessages	boolean	FALSE	Display messages during the rendering loop to the user. These display in the bottom left corner of the component and automatically disappear as new messages are displayed, or after 2 seconds has passed
size	string	Medium	The size of the component on the page
useCommunities	boolean		If you are using the SimpleRenderer within a Community, this is required to fetch resources based on the current community url path
userInteracted	boolean	FALSE	Is set to true when a user drags, points, scrolls or clicks on the rendering
showUserMessages	boolean	FALSE	Display messages during the rendering loop to the user. These display in the bottom left corner of the component and automatically disappear as new messages are displayed, or after 2 seconds has passed
size	string	Medium	The size of the component on the page
useCommunities	boolean		If you are using the SimpleRenderer within a Community, this is required to fetch resources based on the current community url path
userInteracted	boolean	FALSE	Is set to true when a user drags, points, scrolls or clicks on the rendering