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
childId
number
childDockId
number
parentId
number
parentDockId
number
position
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
animations
parameterGroups
parameters
getComponent
▸ getComponent(componentId
): KernelComponent
Parameters
componentId
number
Returns
getComponentId
▸ getComponentId(componentId
): string
Parameters
componentId
number
Returns
string
getComponentParameters
▸ getComponentParameters(componentId
): KernelParameter
[]
Parameters
componentId
number
Returns
getExternalComponentModuleIds
▸ getExternalComponentModuleIds(objectOrPlanComponentId
): ExternalModuleInformation
Parameters
objectOrPlanComponentId
number
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
kernelConversationId
number
configurationObject
string
position
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