Types
Dumb module with list of all types used and available in Mimeeq Embed.
3D Visualization
- FalloffType
- FovMode
- IntensityMode
- LightType
- CameraSettings
- CustomerHotSpots
- EnvTexture
- GridSettings
- GroundSettings
- HotSpotInfo
- LightSettings
- Loader
- LoaderMessage
- PaletteHotSpots
- PaletteMesh
- Scene3D
- Scene3DConnectedProduct
- SceneBoundingBoxSettings
- SceneConfig
- ShadowSettings
- Color3
AR
Actions
Animation
AugmentedReality
Authentication
- AuthErrorTypes
- AppSyncConfig
- AuthError
- AuthOptions
- Authorization
- MimeeqAuth
- MountForgotPasswordPayload
- MountLoginPayload
- MountUserProfilePayload
- S3Options
- SuccessResponse
- UserData
- ForgotPassword
- ForgotPasswordSubmit
- GetToken
- GetUserData
- HavePermissions
- InitializeAWS
- MountAuth
- OnLoginSuccess
- ResendSignUp
- SignIn
- SignOut
Authorization
Basket
- BasketSubmissionData
- CartContactInfo
- CartCustomField
- CartForEmail
- CartItem
- CartItemWithPriceSettings
- CartSubmitResult
- CustomerBasket
- InterfaceAddToCartConfig
- PreSubmitResponse
- SubmissionDataParameters
- GetCartItemsResponse
- PrepareCartImage
- RecalculateCartResponse
Basket Operations
- AddItemToCart
- CreateCart
- GetCartForPreview
- GetCartItems
- GetCartSubmissionFormAction
- PreSubmitCart
- RecalculateCart
- RemoveCartItem
- SubmitCart
CameraControl
- DecreaseZoom
- FreezeCanvasScrolling
- IncreaseZoom
- RegisterSceneCanvasView
- RestoreCameraPosition
- SetSceneInputCanvas
- SetZoom
- UnfreezeCanvasScrolling
- UnregisterSceneCanvasView
- ZoomOut
Canvas
- AspectRatioType
- FreezeCanvasScrolling
- RegisterSceneCanvasView
- SetSceneInputCanvas
- UnfreezeCanvasScrolling
- UnregisterSceneCanvasView
Common
Communications
Configuration
Configuration Actions
Configuration Options
Core
Customer
- CustomerBillingAndUsageSettings
- CustomerBillingAndUsageSettingsSaveModel
- CustomerConfigState
- CustomerConfiguratorSessionMonth
- CustomerConfiguratorSessions
- CustomerGeneralStatistics
- CustomerLimits
- CustomerPartnersUsageStatisticItem
- CustomerUsageAlerts
- CustomerUsageStatisticItem
Customer Configuration
E-commerce
Embed
spatialAdjustmentFailureCodes
constspatialAdjustmentFailureCodes:object
Stable failure codes returned when a modular spatial adjustment cannot be committed.
Integrations can use these codes to distinguish collisions, broken snap relationships, child attachment failures, and unexpected transaction failures without parsing messages.
Type Declaration
childNotPreserved
readonlychildNotPreserved:"SPATIAL_ADJUSTMENT_CHILD_NOT_PRESERVED"='SPATIAL_ADJUSTMENT_CHILD_NOT_PRESERVED'
collision
readonlycollision:"SPATIAL_ADJUSTMENT_COLLISION"='SPATIAL_ADJUSTMENT_COLLISION'
connectionNotPreserved
readonlyconnectionNotPreserved:"SPATIAL_ADJUSTMENT_CONNECTION_NOT_PRESERVED"='SPATIAL_ADJUSTMENT_CONNECTION_NOT_PRESERVED'
failed
readonlyfailed:"SPATIAL_ADJUSTMENT_FAILED"='SPATIAL_ADJUSTMENT_FAILED'
Embeds
Enums
- AddToCartPlacement
- CustomFieldType
- ElementActionType
- FilterWidgetType
- FontStyle
- ModularPlacementType
- OptionSetMode
- OptionSetType
- SliderStepIndicator
- Status
- ThumbStyle
- WidgetType
- YesNoValue
- TrashModuleType
Events
- AppTemplateErrorEventPayload
- ArGoBackEventPayload
- BasketCreatedEventPayload
- BasketItemAddedEventPayload
- BasketSubmittedEventPayload
- BasketUpdatedEventPayload
- BeforeAddToCartEventPayload
- ChangeQuantityEventPayload
- ClickHotspotEventPayload
- DeactivateMatchingOptionsEventPayload
- DownloadFileEventPayload
- FavouritesCollectionEventPayload
- FavouritesCollectionItemsEventPayload
- FavouritesDeleteFromCollectionEventPayload
- GenerateArShortCodeEventPayload
- MimeeqEventMap
- ModularLoadSceneEventPayload
- ModularProductSceneEventPayload
- ModularSaveSceneEventPayload
- ModularSelectOptionEventPayload
- ModularSelectOptionMultipleEventPayload
- ModularSelectProductToAddEventPayload
- OpenRelatedProductEventPayload
- PriceChangeEventPayload
- ProductListSelectProductEventPayload
- ProductPrefixEventPayload
- ResendSignupConfirmCodeEventPayload
- SceneValidationEventPayload
- SelectCompanyEventPayload
- SelectFavouritesCollectionEventPayload
- SelectFiltersEventPayload
- SelectOptionEventPayload
- SelectPopularVariantEventPayload
- SelectPriceTypeEventPayload
- SelectTabEventPayload
- TreeUnmountedEventPayload
- EventDispatchCallback
- LoginSuccessEventPayload
- SignUpSuccessEventPayload
- UserSignedInEventPayload
Exporters
- ApiPdfConfig
- PageSettings
- PdfDocumentTabConfiguration
- PDFVisibleBlock
- ExportGLB
- ExportOBJ
- ExportSTL
- ExportUSDZ
- GenerateProductPDF
- PdfPageRenderer
- SaveImage
- ShowExportImageModal
- ShowExportModal
- ShowExportPDF
Favorites
- FavouriteType
- Favourite
- FavouriteCollection
- FavouriteCollectionItems
- FavouriteItem
- CreateFavouriteCollection
- GetFavouriteCollections
- GetFavouriteItems
- SaveFavouriteConfiguration
- SaveFavouriteScene
- SaveFavouriteSceneAs
Form Validation
History
Hotspots
Icons
- ApiIconsConfig
- BasketIcons
- ConfiguratorIcons
- FormIcons
- MessageWidgetIcons
- MiscIcons
- ModularIcons
- OptionPanelIcons
- QuickIconsIcons
- ShareIcons
- WidgetIcons
Image Widget
- ImageWidgetBlock
- ImageWidgetAddNewImages
- ImageWidgetRemoveImages
- ImageWidgetSelectImage
- SetImageWidgetActiveBlock
- SetImageWidgetLibraryState
Inventory
Media Management
Modular
- RotationGizmoMode
- ToolbarRotateMode
- CurrentElementMetadata
- ElementAction
- ElementLocation
- ModularElement
- ModularPrices
- ModularRequiredSnap
- ModularSceneElement
- ModularSceneElementRequiredSnaps
- ModularSceneRequiredSnap
- ModularSceneValidity
- ModularSnapConnectionTarget
- ProductElement
- RotationGizmoSettings
- SnapConnection
- SnapConnectionMeta
- SnapConnectionPartial
- SnapMeta
- ToolbarData
- VariantCodes
- FreeSnaps
- MarkOptionModular
- ModularRequiredSnapStatus
- ModularSceneElements
- ModularSceneElementSettings
- SaveFavouriteScene
- SaveFavouriteSceneAs
ModularControl
- AddProductToSnappingPoint
- CancelOperations
- CheckCanMove
- ChooseProductToAdd
- ClearScene
- CopyStyles
- DeselectAllModels
- EnableClone
- EnableMove
- EnableReplace
- FlipProduct
- GetBoundingBoxPosition2d
- GetModularShareUrl
- HoverProductForAction
- LoadModularScene
- OpenFinishModal
- OpenLoadSceneModal
- OpenSaveSceneAs
- PasteStyles
- RemoveProducts
- RemoveSelected
- RotateModel
- SelectElement
- ToggleApplyOptionsForAll
- ToggleApplyOptionsForInstances
- ToggleGrid
- ToggleSlide
Observers
- ConfigObservers
- HistoryObservers
- MiscObservers
- ModularObservers
- Observers
- OptionSetsObservers
- PricingObservers
- ProductListObservers
- ProductObservers
OptionSelection
- FilterOptions
- MarkOption
- MarkOptionModular
- PrepareFilterOptions
- ToggleApplyOptionsForAll
- ToggleApplyOptionsForInstances
OptionSets
- BlockEngraveSettings
- BlockGroup
- BlockGroupSelectedValue
- BlockGroupWithStatus
- BlockSelectedValue
- ButtonWidgetSettings
- CanvasLayerMetadata
- CustomColorOption
- CustomImageOption
- EngravingOption
- EngravingSettings
- GenericOptionSetOption
- GroupContainerWithStatus
- GroupsPreview
- ImageWidgetImage
- InputOption
- LetterMappings
- MetaFieldFileValue
- OptionSetBlock
- OptionSetData
- OptionSetOption
- PreparedBlock
- PrintOnDemandImage
- PrintOnDemandLayer
- PrintOnDemandOption
- SelectedOptionSimple
- SimpleOption
- SliderOption
- BlockGroupContainer
- FontWeight
- Metafields
- MetaFieldValue
- MetaFieldValuePrimitive
- OptionSetsBlocks
- OptionSetsData
- SelectedOptions
Other
- AnimationGroupType
- BundleItemType
- CustomMeasurementDisplayMode
- SystemNotificationType
- AdminSideMenuItem
- AiStudioCreditsService
- AiStudioMediaService
- AiStudioProjectService
- AIStudioTier
- AiStudioToolDataOutput
- AiStudioToolOutput
- AiStudioToolsService
- AnisotropyDirection
- BaseColorTokens
- BaseFontSizeTokens
- BaseLineHeightTokens
- BaseRadiusTokens
- BaseSpaceTokens
- BaseStrokeWidthTokens
- BaseTokens
- BlockGroupPreview
- BoxRect
- CameraPosition
- ColorPreset
- ConnectedSnapInfo
- CssVariableOptions
- CustomerBillingAndUsageSettingsUpdateResponse
- CustomerNotification
- Dealer
- DimensionsUnitSettings
- DynamicMaterialMetallicTexture
- DynamicMaterialTexture
- EmbedTemplateDimensionsSettings
- EmbedTranslationKeyDetails
- EmbedTranslationSet
- EmbedTranslationSetConnection
- EmbedTranslationSetListItem
- ExtendedSnapRule
- Filters
- FiltersWidget
- FinishEventPayload
- FinishModularElement
- FontFamilies
- ForwardMail
- GenericMaterialMetallicTexture
- GenericMaterialTexture
- GlobalDefaultEmbedTranslationsGetResponse
- GlobalDefaultEmbedTranslationsPutBody
- InterfaceCartConfig
- IntlMessageFormatOptions
- InvertMeshConfig
- LightboxItem
- LoadScenePayload
- MagnetizeDetails
- Material3D
- MaterialAnisotropy
- MaterialBasic
- MaterialBump
- MaterialClearCoat
- MaterialColorGrading
- MaterialMeta
- MaterialParameters
- MaterialSheen
- MaterialSubSurface
- MaterialUvScaleOffset
- Metadata
- MetaFieldSetValue
- ModelDimensions
- ModelMorphTarget
- ModularCanvasControlSettings
- ModularCanvasControlsSettings
- ModularDefaultConfiguration
- ModularHistoryItem
- ModularSceneAppearanceProductSettings
- ModularSceneAppearanceSettings
- ModularSelectedProduct
- ModularTextureSize
- NeutralColorScale
- PdfDocumentTabGallery
- PdfDocumentTabGeneric
- PdfDocumentTabMaterials
- PdfDocumentTabPopular
- PDFHeadLink
- PDFHeadMeta
- PDFHeadScript
- PDFHeadStyle
- PDFHeadTitle
- PDFMargin
- PriceCodeGroup
- PricingSettings
- ProductPriceListCode
- Quaternion
- RawDraftContentBlock
- RawDraftContentState
- RawDraftEntity
- RawDraftEntityRange
- RawDraftInlineStyleRange
- SemanticBackgroundTokens
- SemanticColorTokens
- SemanticIconTokens
- SemanticRadiusTokens
- SemanticStrokeTokens
- SemanticStrokeWidthTokens
- SemanticSurfaceTokens
- SemanticTextTokens
- SemanticTokens
- SideMenuSubItem
- SliderRange
- StateVariants
- StaticMaterialMetallicTexture
- StaticMaterialTexture
- SubscribeValueWrapper
- TextureSize
- Theme
- ThumbnailsWidget
- TokenGenerationInput
- Tokens
- TransparencyScale
- TransparencyScaleExtended
- Vector3
- VirtualModel
- WebGLProductConfig
- WidgetService
- WidgetSettings
- BlockGroups
- CoreDraftBlockType
- CoverageDataSet
- CssVariables
- CustomBlockType
- CustomMeasurementVisibilityState
- DeepPartial
- DismissUserNotification
- DraftBlockType
- DraftEntityMutability
- DraftInlineStyleType
- EmbedTranslationKeyDetailsMap
- EmbedTranslationKeyDetailsPutMap
- FormatMessage
- FormatXMLElementFn
- GenerateBundleSettings
- GetBundleCoverageInfo
- GetBundlingCoverage
- GetCustomerBillingAndUsageSettings
- GetCustomerConfiguratorSessions
- GetUserSystemNotifications
- InvertMeshesConfig
- MaterialMetallicTexture
- MaterialTexture
- MessagePrimitiveType
- ModularCanvasControlBackgroundSource
- ModularCanvasControlIconMode
- ModularCanvasControlIconSymbol
- ModularCanvasControlShape
- ModularCanvasControlSize
- Observable
- OnUploadSuccess
- OverrideParamsSimple
- PaperSize
- ParsedBundleSettings
- ParsedBundleSettingsResponse
- ParsedBundlingCoverageResponse
- PdfDocumentTab
- PDFHeadElement
- PrimitiveType
- Promisable
- Subscription
- TSceneBBComputationModeOptions
- UpdateCustomerBillingAndUsageSettings
- UpdateCustomerBillingAndUsageSettingsResponse
Pricing
- CodeGroupScope
- PriceTypeEnum
- VatType
- AliasCode
- CustomerPriceSettings
- ItemMaster
- MarketCostPriceItem
- ModularPrices
- PartnerUserDefaultSettings
- PriceData
- PriceLevel
- PriceModifier
- PriceType
- PricingMarketCostPrice
- PriceOptions
- SetDealer
- SetPrice
- SetPriceType
- SetPricingSettings
- SetQuantity
Product
Product Architecture
Product Configuration
Product Customization
Product Data
Product Management
Product Tabs
Product UI
Product Visualization
- GroupPreviewImageSource
- HotspotBlockType
- MetadataType
- TemplateBlock
- TemplateData
- Get2dViewImage
- Get3dInformationTemplate
- GetProductCarouselImages
- GetProductLightboxImages
- GetProductThumbnail
- SetCarouselView
ProductTabs
- GalleryEntry
- GalleryTabResponse
- PopularConfigItem
- PopularConfiguration
- ProductTab
- TabFileItem
- TabMaterial
- GetTabFiles
- GetTabFinishes
- GetTabGallery
- GetTabPopular
- SelectPopularConfig
Products
RelatedProducts
- RelatedItem
- RelatedItemConfiguration
- RelatedMapping
- GetRelatedDynamicData
- GetRelatedProducts
- SelectRelatedProduct
Responsive Design
Rules
Scene
SceneControl
- DecreaseZoom
- FreezeCanvasScrolling
- IncreaseZoom
- OpenSaveSceneAs
- RegisterSceneCanvasView
- RestoreCameraPosition
- SetDimensionsUnit
- SetSceneInputCanvas
- SetZoom
- ToggleDimensions
- ToggleGrid
- UnfreezeCanvasScrolling
- UnregisterSceneCanvasView
- ZoomOut
Storage
Text Formatting
Theme
- BaseTheme
- ColorTints
- DefaultPalette
- Palette
- PaletteBackground
- PaletteBorder
- PaletteBoxShadow
- PaletteColor
- PaletteCommon
- PaletteGroup
- PaletteHeader
- PaletteHotSpots
- PaletteScrollbar
- PaletteStatus
- PaletteTypography
- ThemeType
Theming
Typography
UI Components
UI Configuration
- ButtonColor
- ButtonShape
- ButtonSizeType
- ButtonVariantType
- ButtonWidth
- FilterDisplayState
- FilterWidgetMode
- MessageIconType
- MessageType
- QuickIconsType
- TabType
- WidgetSourceType
- EmbedTemplatePDFSettings
- UiVisibilityConfig
User Interface
Utility
Utils
- Utils
- AddToCart
CloseConfigurator- GetShortcode
- SetPrice
- SetPricingSettings
ShowConfiguratorShowModular- TakeScreenshot