TypingsKernel.ConfiguratorKernelClass

typings/kernel.ConfiguratorKernelClass

Table of contents

Methods

Methods

addPriceList

â–¸ addPriceList(newLocale): void

Parameters

Name
Type

newLocale

string

Returns

void


assetsLoaded

â–¸ assetsLoaded(assets): void

Parameters

Name
Type

Returns

void


cancelDocking

â–¸ cancelDocking(componentId, undoDrag): void

Parameters

Name
Type

componentId

number

undoDrag

boolean

Returns

void


clearAll

â–¸ clearAll(): void

Returns

void


clearScene

â–¸ clearScene(): void

Returns

void


createNewSerializedConfiguration

â–¸ createNewSerializedConfiguration(configurationRuntimeId): string

Parameters

Name
Type

configurationRuntimeId

number

Returns

string


deleteComponent

â–¸ deleteComponent(componentId): void

Parameters

Name
Type

componentId

number

Returns

void


deletePlanComponent

â–¸ deletePlanComponent(componentId): void

Parameters

Name
Type

componentId

any

Returns

void


deletePlanComponents

â–¸ deletePlanComponents(componentIds): void

Parameters

Name
Type

componentIds

any

Returns

void


dockComponent

â–¸ dockComponent(childId, childDockId, parentId, parentDockId): void

Parameters

Name
Type

childId

number

childDockId

number

parentId

number

parentDockId

number

Returns

void


dockComponentWithPosition

â–¸ dockComponentWithPosition(childId, childDockId, parentId, parentDockId, position): void

Parameters

Name
Type

childId

number

childDockId

number

parentId

number

parentDockId

number

Returns

void


getChildrenOfPlanComponent

â–¸ getChildrenOfPlanComponent(componentId, onlyPossible, onlyVisible): KernelPossibleChild[]

Parameters

Name
Type

componentId

number

onlyPossible

boolean

onlyVisible

boolean

Returns

KernelPossibleChild[]


getChildrenOfPlanObject

â–¸ getChildrenOfPlanObject(planObjectId, onlyPossible, onlyVisible): KernelPossibleChild[]

Parameters

Name
Type

planObjectId

number

onlyPossible

boolean

onlyVisible

boolean

Returns

KernelPossibleChild[]


getCommonPlanComponentParameters

â–¸ getCommonPlanComponentParameters(componentIds): Object

Parameters

Name
Type

componentIds

any

Returns

Object

Name
Type

animations

parameterGroups

parameters


getComponent

â–¸ getComponent(componentId): KernelComponent

Parameters

Name
Type

componentId

number

Returns

KernelComponent


getComponentId

â–¸ getComponentId(componentId): string

Parameters

Name
Type

componentId

number

Returns

string


getComponentOrModuleInformation

â–¸ getComponentOrModuleInformation(objectOrPlanComponentId): KernelObjectInformation

Parameters

Name
Type

objectOrPlanComponentId

number

Returns

KernelObjectInformation


getComponentParameters

â–¸ getComponentParameters(componentId): KernelParameter[]

Parameters

Name
Type

componentId

number

Returns

KernelParameter[]


getExternalComponentModuleIds

â–¸ getExternalComponentModuleIds(objectOrPlanComponentId): ExternalModuleInformation

Parameters

Name
Type

objectOrPlanComponentId

number

Returns

ExternalModuleInformation


getExternalObjectAttribute

â–¸ getExternalObjectAttribute(objectOrPlanComponentId, attributeKey, value): ExternalAttributeInformation

Parameters

Name
Type

objectOrPlanComponentId

number

attributeKey

string

value

string

Returns

ExternalAttributeInformation


getExternalObjectDocking

â–¸ getExternalObjectDocking(childId, childDockId, parentId, parentDockId): KernelExternalObjectDocking

Parameters

Name
Type

childId

number

childDockId

number

parentId

number

parentDockId

number

Returns

KernelExternalObjectDocking


getFullPartList

â–¸ getFullPartList(): KernelPartList

Returns

KernelPartList


getHashOfConfiguration

â–¸ getHashOfConfiguration(aPlanObjectOrComponentId): string

Parameters

Name
Type

aPlanObjectOrComponentId

number

Returns

string


getHashOfSerializedConfiguration

â–¸ getHashOfSerializedConfiguration(serializedConfiguration): string

Parameters

Name
Type

serializedConfiguration

string

Returns

string


getPartList

â–¸ getPartList(getPartList): KernelPartList

Parameters

Name
Type

getPartList

number

Returns

KernelPartList


getPlanComponentAnimations

â–¸ getPlanComponentAnimations(planComponentId): KernelAnimation[]

Parameters

Name
Type

planComponentId

number

Returns

KernelAnimation[]


getPlanComponentPossibleChildren

â–¸ getPlanComponentPossibleChildren(componentId): KernelPossibleChild[]

Parameters

Name
Type

componentId

number

Returns

KernelPossibleChild[]


getPlanObject

â–¸ getPlanObject(planObjectId): PlanObject

Parameters

Name
Type

planObjectId

number

Returns

PlanObject


getPlanObjectAnimations

â–¸ getPlanObjectAnimations(planObjectId): KernelAnimation[]

Parameters

Name
Type

planObjectId

number

Returns

KernelAnimation[]


getPlanObjectChildren

â–¸ getPlanObjectChildren(planObjectId, onlyPossible, onlyVisible): KernelPossibleChild[]

Parameters

Name
Type

planObjectId

number

onlyPossible

boolean

onlyVisible

boolean

Returns

KernelPossibleChild[]


getPlanObjectFromPlanComponent

â–¸ getPlanObjectFromPlanComponent(componentId): PlanObject

Parameters

Name
Type

componentId

number

Returns

PlanObject


getPlanObjectParameters

â–¸ getPlanObjectParameters(planObjectId): KernelParameter[]

Parameters

Name
Type

planObjectId

number

Returns

KernelParameter[]


getPlanObjectPossibleChildren

â–¸ getPlanObjectPossibleChildren(componentId): KernelPossibleChild[]

Parameters

Name
Type

componentId

number

Returns

KernelPossibleChild[]


getRootPlanComponentIdFromObjectId

â–¸ getRootPlanComponentIdFromObjectId(planObjectId): number

Parameters

Name
Type

planObjectId

number

Returns

number


getSerializedConfiguration

â–¸ getSerializedConfiguration(planObjectOrComponentId): string

Parameters

Name
Type

planObjectOrComponentId

number

Returns

string


isExternalPlanObject

â–¸ isExternalPlanObject(objectOrPlanComponentId): boolean

Parameters

Name
Type

objectOrPlanComponentId

number

Returns

boolean


loadComponentDefinition

â–¸ loadComponentDefinition(conversationId, component): void

Parameters

Name
Type

conversationId

number

component

string

Returns

void


loadConfiguration

â–¸ loadConfiguration(kernelConversationId, configurationObject, position): void

Parameters

Name
Type

kernelConversationId

number

configurationObject

string

Returns

void


loadExternalAttributeDefinition

â–¸ loadExternalAttributeDefinition(serializedDefinition): void

Parameters

Name
Type

serializedDefinition

string

Returns

void


loadFreeFlyingConfiguration

â–¸ loadFreeFlyingConfiguration(conversationId, configuration): void

Parameters

Name
Type

conversationId

number

configuration

string

Returns

void


loadPlainComponent

â–¸ loadPlainComponent(conversationId, componentId, configuration): void

Parameters

Name
Type

conversationId

number

componentId

string

configuration

string

Returns

void


registerDebugClient

â–¸ registerDebugClient(debugClient): void

Parameters

Name
Type

debugClient

Returns

void


requestDeltaPlanComponentConstruction

â–¸ requestDeltaPlanComponentConstruction(componentId): void

Parameters

Name
Type

componentId

number

Returns

void


requestPlanComponentConstruction

â–¸ requestPlanComponentConstruction(componentId): void

Parameters

Name
Type

componentId

number

Returns

void


requestPlanComponentConstructionRecursive

â–¸ requestPlanComponentConstructionRecursive(componentId): void

Parameters

Name
Type

componentId

number

Returns

void


requestPlanObjectConstruction

â–¸ requestPlanObjectConstruction(planObjectId): void

Parameters

Name
Type

planObjectId

number

Returns

void


requestPreviewGeometry

â–¸ requestPreviewGeometry(componentId, planObjectId, allowInsertInBetween): void

Parameters

Name
Type

componentId

number

planObjectId

number

allowInsertInBetween

boolean

Returns

void


requestPreviewGeometryForExternalObject

â–¸ requestPreviewGeometryForExternalObject(componentId, planObjectId, allowInsertInBetween): void

Parameters

Name
Type

componentId

string

planObjectId

number

allowInsertInBetween

boolean

Returns

void


resetPriceListIds

â–¸ resetPriceListIds(): void

Returns

void


setActiveGroupInView

â–¸ setActiveGroupInView(groupId): void

Parameters

Name
Type

groupId

string

Returns

void


setActiveGroupInViewForPlanObject

â–¸ setActiveGroupInViewForPlanObject(groupId, runtimeId): void

Parameters

Name
Type

groupId

string

runtimeId

number

Returns

void


setAssetInvalid

â–¸ setAssetInvalid(assetType, idOrUrl, quality): void

Parameters

Name
Type

assetType

idOrUrl

string

quality

number

Returns

void


setComponentParameter

â–¸ setComponentParameter(componentId, parameterKey, value): void

Parameters

Name
Type

componentId

number

parameterKey

string

value

string

Returns

void


setDockInsertPreviewBoxParameters

â–¸ setDockInsertPreviewBoxParameters(thickness, protruding, intruding, bevelSize): void

Parameters

Name
Type

thickness

number

protruding

number

intruding

number

bevelSize

number

Returns

void


setEnvironmentVariable

â–¸ setEnvironmentVariable(key, value): void

Parameters

Name
Type

key

string

value

any

Returns

void


setExternalObjectConstructionProperties

â–¸ setExternalObjectConstructionProperties(serializedProperties): void

Parameters

Name
Type

serializedProperties

string

Returns

void


setLevel

â–¸ setLevel(restrictionLevel): void

Parameters

Name
Type

restrictionLevel

number

Returns

void


setPlanComponentParameters

â–¸ setPlanComponentParameters(componentIds, parameterKey, value): void

Parameters

Name
Type

componentIds

any

parameterKey

string

value

string

Returns

void


setPlanObjectParameter

â–¸ setPlanObjectParameter(planObjectId, parameterKey, value): void

Parameters

Name
Type

planObjectId

number

parameterKey

string

value

string

Returns

void


setUpdateCallbacksOnlyIfGeometryIsReady

â–¸ setUpdateCallbacksOnlyIfGeometryIsReady(onlyUpdateIfReady): void

Parameters

Name
Type

onlyUpdateIfReady

boolean

Returns

void

â–¸ setUpdateCallbacksOnlyIfGeometryIsReady(updateCallbacksOnlyIfGeometryIsReady): void

Parameters

Name
Type

updateCallbacksOnlyIfGeometryIsReady

boolean

Returns

void


syncPlanObjectToView

â–¸ syncPlanObjectToView(conversationId, planObjectId): void

Parameters

Name
Type

conversationId

number

planObjectId

number

Returns

void


useEnvironmentGeometry

â–¸ useEnvironmentGeometry(requestEnvironmentGeometry): void

Parameters

Name
Type

requestEnvironmentGeometry

boolean

Returns

void


useHDGeometry

â–¸ useHDGeometry(requestUseHDGeometry): void

Parameters

Name
Type

requestUseHDGeometry

boolean

Returns

void

Last updated