TypingsKernel.ConfiguratorKernelClass
typings/kernel.ConfiguratorKernelClass
Table of contents
Methods
Methods
addPriceList
â–¸ addPriceList(newLocale
): void
Parameters
newLocale
string
Returns
void
assetsLoaded
â–¸ assetsLoaded(assets
): void
Parameters
assets
Returns
void
cancelDocking
â–¸ cancelDocking(componentId
, undoDrag
): void
Parameters
componentId
number
undoDrag
boolean
Returns
void
clearAll
â–¸ clearAll(): void
Returns
void
clearScene
â–¸ clearScene(): void
Returns
void
createNewSerializedConfiguration
â–¸ createNewSerializedConfiguration(configurationRuntimeId
): string
Parameters
configurationRuntimeId
number
Returns
string
deleteComponent
â–¸ deleteComponent(componentId
): void
Parameters
componentId
number
Returns
void
deletePlanComponent
â–¸ deletePlanComponent(componentId
): void
Parameters
componentId
any
Returns
void
deletePlanComponents
â–¸ deletePlanComponents(componentIds
): void
Parameters
componentIds
any
Returns
void
dockComponent
â–¸ dockComponent(childId
, childDockId
, parentId
, parentDockId
): void
Parameters
childId
number
childDockId
number
parentId
number
parentDockId
number
Returns
void
dockComponentWithPosition
â–¸ dockComponentWithPosition(childId
, childDockId
, parentId
, parentDockId
, position
): void
Parameters
Returns
void
getChildrenOfPlanComponent
â–¸ getChildrenOfPlanComponent(componentId
, onlyPossible
, onlyVisible
): KernelPossibleChild
[]
Parameters
componentId
number
onlyPossible
boolean
onlyVisible
boolean
Returns
getChildrenOfPlanObject
â–¸ getChildrenOfPlanObject(planObjectId
, onlyPossible
, onlyVisible
): KernelPossibleChild
[]
Parameters
planObjectId
number
onlyPossible
boolean
onlyVisible
boolean
Returns
getCommonPlanComponentParameters
â–¸ getCommonPlanComponentParameters(componentIds
): Object
Parameters
componentIds
any
Returns
Object
getComponent
â–¸ getComponent(componentId
): KernelComponent
Parameters
componentId
number
Returns
getComponentId
â–¸ getComponentId(componentId
): string
Parameters
componentId
number
Returns
string
getComponentOrModuleInformation
â–¸ getComponentOrModuleInformation(objectOrPlanComponentId
): KernelObjectInformation
Parameters
objectOrPlanComponentId
number
Returns
getComponentParameters
â–¸ getComponentParameters(componentId
): KernelParameter
[]
Parameters
componentId
number
Returns
getExternalComponentModuleIds
â–¸ getExternalComponentModuleIds(objectOrPlanComponentId
): ExternalModuleInformation
Parameters
objectOrPlanComponentId
number
Returns
getExternalObjectAttribute
â–¸ getExternalObjectAttribute(objectOrPlanComponentId
, attributeKey
, value
): ExternalAttributeInformation
Parameters
objectOrPlanComponentId
number
attributeKey
string
value
string
Returns
getExternalObjectDocking
â–¸ getExternalObjectDocking(childId
, childDockId
, parentId
, parentDockId
): KernelExternalObjectDocking
Parameters
childId
number
childDockId
number
parentId
number
parentDockId
number
Returns
getFullPartList
â–¸ getFullPartList(): KernelPartList
Returns
getHashOfConfiguration
â–¸ getHashOfConfiguration(aPlanObjectOrComponentId
): string
Parameters
aPlanObjectOrComponentId
number
Returns
string
getHashOfSerializedConfiguration
â–¸ getHashOfSerializedConfiguration(serializedConfiguration
): string
Parameters
serializedConfiguration
string
Returns
string
getPartList
â–¸ getPartList(getPartList
): KernelPartList
Parameters
getPartList
number
Returns
getPlanComponentAnimations
â–¸ getPlanComponentAnimations(planComponentId
): KernelAnimation
[]
Parameters
planComponentId
number
Returns
getPlanComponentPossibleChildren
â–¸ getPlanComponentPossibleChildren(componentId
): KernelPossibleChild
[]
Parameters
componentId
number
Returns
getPlanObject
â–¸ getPlanObject(planObjectId
): PlanObject
Parameters
planObjectId
number
Returns
getPlanObjectAnimations
â–¸ getPlanObjectAnimations(planObjectId
): KernelAnimation
[]
Parameters
planObjectId
number
Returns
getPlanObjectChildren
â–¸ getPlanObjectChildren(planObjectId
, onlyPossible
, onlyVisible
): KernelPossibleChild
[]
Parameters
planObjectId
number
onlyPossible
boolean
onlyVisible
boolean
Returns
getPlanObjectFromPlanComponent
â–¸ getPlanObjectFromPlanComponent(componentId
): PlanObject
Parameters
componentId
number
Returns
getPlanObjectParameters
â–¸ getPlanObjectParameters(planObjectId
): KernelParameter
[]
Parameters
planObjectId
number
Returns
getPlanObjectPossibleChildren
â–¸ getPlanObjectPossibleChildren(componentId
): KernelPossibleChild
[]
Parameters
componentId
number
Returns
getRootPlanComponentIdFromObjectId
â–¸ getRootPlanComponentIdFromObjectId(planObjectId
): number
Parameters
planObjectId
number
Returns
number
getSerializedConfiguration
â–¸ getSerializedConfiguration(planObjectOrComponentId
): string
Parameters
planObjectOrComponentId
number
Returns
string
isExternalPlanObject
â–¸ isExternalPlanObject(objectOrPlanComponentId
): boolean
Parameters
objectOrPlanComponentId
number
Returns
boolean
loadComponentDefinition
â–¸ loadComponentDefinition(conversationId
, component
): void
Parameters
conversationId
number
component
string
Returns
void
loadConfiguration
â–¸ loadConfiguration(kernelConversationId
, configurationObject
, position
): void
Parameters
Returns
void
loadExternalAttributeDefinition
â–¸ loadExternalAttributeDefinition(serializedDefinition
): void
Parameters
serializedDefinition
string
Returns
void
loadFreeFlyingConfiguration
â–¸ loadFreeFlyingConfiguration(conversationId
, configuration
): void
Parameters
conversationId
number
configuration
string
Returns
void
loadPlainComponent
â–¸ loadPlainComponent(conversationId
, componentId
, configuration
): void
Parameters
conversationId
number
componentId
string
configuration
string
Returns
void
registerDebugClient
â–¸ registerDebugClient(debugClient
): void
Parameters
debugClient
Returns
void
requestDeltaPlanComponentConstruction
â–¸ requestDeltaPlanComponentConstruction(componentId
): void
Parameters
componentId
number
Returns
void
requestPlanComponentConstruction
â–¸ requestPlanComponentConstruction(componentId
): void
Parameters
componentId
number
Returns
void
requestPlanComponentConstructionRecursive
â–¸ requestPlanComponentConstructionRecursive(componentId
): void
Parameters
componentId
number
Returns
void
requestPlanObjectConstruction
â–¸ requestPlanObjectConstruction(planObjectId
): void
Parameters
planObjectId
number
Returns
void
requestPreviewGeometry
â–¸ requestPreviewGeometry(componentId
, planObjectId
, allowInsertInBetween
): void
Parameters
componentId
number
planObjectId
number
allowInsertInBetween
boolean
Returns
void
requestPreviewGeometryForExternalObject
â–¸ requestPreviewGeometryForExternalObject(componentId
, planObjectId
, allowInsertInBetween
): void
Parameters
componentId
string
planObjectId
number
allowInsertInBetween
boolean
Returns
void
resetPriceListIds
â–¸ resetPriceListIds(): void
Returns
void
setActiveGroupInView
â–¸ setActiveGroupInView(groupId
): void
Parameters
groupId
string
Returns
void
setActiveGroupInViewForPlanObject
â–¸ setActiveGroupInViewForPlanObject(groupId
, runtimeId
): void
Parameters
groupId
string
runtimeId
number
Returns
void
setAssetInvalid
â–¸ setAssetInvalid(assetType
, idOrUrl
, quality
): void
Parameters
Returns
void
setComponentParameter
â–¸ setComponentParameter(componentId
, parameterKey
, value
): void
Parameters
componentId
number
parameterKey
string
value
string
Returns
void
setDockInsertPreviewBoxParameters
â–¸ setDockInsertPreviewBoxParameters(thickness
, protruding
, intruding
, bevelSize
): void
Parameters
thickness
number
protruding
number
intruding
number
bevelSize
number
Returns
void
setEnvironmentVariable
â–¸ setEnvironmentVariable(key
, value
): void
Parameters
key
string
value
any
Returns
void
setExternalObjectConstructionProperties
â–¸ setExternalObjectConstructionProperties(serializedProperties
): void
Parameters
serializedProperties
string
Returns
void
setLevel
â–¸ setLevel(restrictionLevel
): void
Parameters
restrictionLevel
number
Returns
void
setPlanComponentParameters
â–¸ setPlanComponentParameters(componentIds
, parameterKey
, value
): void
Parameters
componentIds
any
parameterKey
string
value
string
Returns
void
setPlanObjectParameter
â–¸ setPlanObjectParameter(planObjectId
, parameterKey
, value
): void
Parameters
planObjectId
number
parameterKey
string
value
string
Returns
void
setUpdateCallbacksOnlyIfGeometryIsReady
â–¸ setUpdateCallbacksOnlyIfGeometryIsReady(onlyUpdateIfReady
): void
Parameters
onlyUpdateIfReady
boolean
Returns
void
â–¸ setUpdateCallbacksOnlyIfGeometryIsReady(updateCallbacksOnlyIfGeometryIsReady
): void
Parameters
updateCallbacksOnlyIfGeometryIsReady
boolean
Returns
void
syncPlanObjectToView
â–¸ syncPlanObjectToView(conversationId
, planObjectId
): void
Parameters
conversationId
number
planObjectId
number
Returns
void
useEnvironmentGeometry
â–¸ useEnvironmentGeometry(requestEnvironmentGeometry
): void
Parameters
requestEnvironmentGeometry
boolean
Returns
void
useHDGeometry
â–¸ useHDGeometry(requestUseHDGeometry
): void
Parameters
requestUseHDGeometry
boolean
Returns
void
Last updated