Introduction
Welcome to the documentation for the developers. This part of the documentation is only intended for the developers who wish to use the 'epigraph-configurator' web component and expand on it's default functionality.
If you are have not done it already, follow this Quick Setup Guide to get started with web component before going through the API.
Terminology
Before jumping right into the details about this API, it is important to get familiar with the terminology that we would be using:
SKUs
A sku is a generic term referring to a product in your company's portfolio.
It could be a
- Table,
- a Chair,
- a Bed,
- a Modular Piece of a Bed, etc.
We primarily use the "SKU IDs", which help identify the products that are a part of this configurator and would be possible to be viewed in the 3D space. These SKU IDs may or may not be the same as an entry in your database, so please reach out to us in case of any questions regarding that.
Items
An item is the 3D represntation of a given SKU.
A SKU can have multiple items of itself spawned in the scene. In programming terms, think of the SKU as a class and each instance of this class would be an Item.
Selected Item
A "selected item" is an item within the scene, that could be overriden or performed certain operations on. The only way to currently make an item "selected" is when a user clicks on it in the scene.
For eg.
- Overriding Look of a specific item in the scene.
- Deleting an item from the scene...
Ghosts
Every possible item for a SKU in the 3D scene is called a Ghost.
A ghost is a temporary representation of an item in the scene that only gets finalised as an item once the user wishes to add it to the scene. The number of ghosts in the scene could vary based on the User Experience that you wish to implement.
Hotspots
Every SKU in the configurator is capable of having some annotations in the scene which showcase a specific feature.
A hotspot is a great way to showcase more details about a product in the UI, which would not be possible within the 3D viewer mainly due to the restrictions that come up with hardware capabities of end user devices (specially mobile phones).
TIP: Even if the user has multiple Items of the same SKU in the scene. Hostpots will only show on the last Item spawned for that SKU.
Alert
Very similar to the window.alert method on any modern browser, an alert shows a custom notification to the end-user within the configurator.
Think of an alert as a way of notifying the end-user when an important action takes place in the scene. For eg. when the user is deleting an object from the scene which would delete all the connected objects, an alert asks for a confirmation of this action.
View In Your Space
View In Your Space is an Epigraph registered trademark, that allows the users to view their configuration in their physical space on supported devices.
A SKU can have multiple items of itself spawned in the scene. In programming terms, think of the SKU as a class and each instance of this class would be an Item.