LoadContext

class LoadContext()

Constructors

constructor()

Properties

__LoadContext

Methods

addAttachContext()
addLayerIdToMap()
getAttachContexts()
getAuthoredLayerId()
getChildren()
getParent()
getRuntimeLayerId()
getScsModelKeysOf()
handleExternalModel()
hasChildren()
initializeScsModelKeysOf()
isFirstLoad()
isLoaded()
markAsFirstLoad()
onLoadComplete()
purgeContents()
removeProductOccurrence()
toScsBuffer()

Constructors

LoadContext.constructor(parent, _debugLoadString, scsBufferCache)

Arguments:	parent (LoadContextParent) – None _debugLoadString (`string()`) – None scsBufferCache (`PromiseCache()` <ExternalModelName, ScsBuffer \| null> \| null) – None
Return type:	`LoadContext()`

Properties

LoadContext.__LoadContext

Type:	PhantomMember

Methods

addAttachContext

LoadContext.addAttachContext(context)

Arguments:	context (`AttachContext()`) – None
Return type:	void

addLayerIdToMap

LoadContext.addLayerIdToMap(runtimeId, authoredId)

Arguments:	runtimeId (LayerId) – None authoredId (AuthoredLayerId) – None
Return type:	void

getAttachContexts

LoadContext.getAttachContexts()

Return type:	[`AttachContext()`]

getAuthoredLayerId

LoadContext.getAuthoredLayerId(runtimeId)

Arguments:	runtimeId (LayerId) – None
Return type:	AuthoredLayerId \| null

getChildren

LoadContext.getChildren()

Return type:	[`ProductOccurrence()`]

getParent

LoadContext.getParent()

Return type:	LoadContextParent

getRuntimeLayerId

LoadContext.getRuntimeLayerId(authoredId)

Arguments:	authoredId (AuthoredLayerId) – None
Return type:	LayerId \| null

getScsModelKeysOf

LoadContext.getScsModelKeysOf(modelName)

Arguments:	modelName (ExternalModelName) – None
Return type:	`TrackedOpenPromise()` <[ModelKey] \| null> \| null

handleExternalModel

LoadContext.handleExternalModel(includerAuthoredNodeId, includerInclusionContext, externalInclusionKey)

Arguments:	includerAuthoredNodeId (AuthoredNodeId) – None includerInclusionContext (`InclusionContext()`) – None externalInclusionKey (`InclusionKey()`) – None
Return type:	boolean

hasChildren

LoadContext.hasChildren()

Return type:	boolean

initializeScsModelKeysOf

LoadContext.initializeScsModelKeysOf(modelName)

Arguments:	modelName (ExternalModelName) – None
Return type:	void

isFirstLoad

LoadContext.isFirstLoad()

Return type:	boolean

isLoaded

LoadContext.isLoaded()

Return type:	boolean

markAsFirstLoad

LoadContext.markAsFirstLoad()

Return type:	void

onLoadComplete

LoadContext.onLoadComplete()

Return type:	void

purgeContents

LoadContext.purgeContents()

Return type:	Promise <void>

removeProductOccurrence

LoadContext.removeProductOccurrence(node)

Arguments:	node (`ProductOccurrence()`) – None
Return type:	boolean

toScsBuffer

LoadContext.toScsBuffer(modelName, toAttachData)

Arguments:	modelName (ExternalModelName) – None toAttachData (ToAttachDataFunc) – None
Return type:	Promise <ScsBuffer \| Response \| null>