TreeLoader

class TreeLoader()

Constructors

• constructor()

Properties

• __TreeLoader

Methods

• attachByExternalModelInfo()
• cancelActiveAttachmentProcess()
• cancelPendingLoads()
• firstAssemblyDataHeader()
• isIdle()
• loadByAssemblyData()
• loadByScsBuffer()
• loadByScsFile()
• loadByStream()
• loadByXmlDoc()
• loadByXmlFile()
• notifyDirectRequest()
• onLoadChildProductOccurrence()
• reset()
• setPrefetchScsCutoffScale()
• waitOnCurrentLoads()

---

Constructors

TreeLoader.constructor(assemblyTree, scAttacher, engine, view, callbackManager)

Arguments:

• assemblyTree (IAssemblyTree()) – None
• scAttacher (ScAttacher()) – None
• engine (IScEngine()) – None
• view (IView()) – None
• callbackManager (ICallbackManager()) – None

Return type:

TreeLoader()

Properties

TreeLoader.__TreeLoader

Type:PhantomMember

Methods

attachByExternalModelInfo

TreeLoader.attachByExternalModelInfo(info, parent, inclusionContext)

Arguments:

• info (ExternalModelInfo) – None
• parent (ProductOccurrence()) – None
• inclusionContext (InclusionContext()) – None

Return type:

Promise <AttachContext()>

cancelActiveAttachmentProcess

TreeLoader.cancelActiveAttachmentProcess()

Return type:Promise <void>

cancelPendingLoads

TreeLoader.cancelPendingLoads()

Return type:Promise <void>

firstAssemblyDataHeader

TreeLoader.firstAssemblyDataHeader()

Return type:AssemblyDataHeader() | null

isIdle

TreeLoader.isIdle()

Return type:boolean

loadByAssemblyData

TreeLoader.loadByAssemblyData(config, parent, modelInc, assemblyData)

Arguments:

• config (LoadSubtreeConfig()) – None
• parent (ProductOccurrence()) – None
• modelInc (ModelInc()) – None
• assemblyData (AssemblyData()) – None

Return type:

Promise <LoadContext()>

loadByScsBuffer

TreeLoader.loadByScsBuffer(config, parent, scsBuffer)

Arguments:

• config (LoadSubtreeConfig()) – None
• parent (ProductOccurrence()) – None
• scsBuffer (ScsBuffer()) – None

Return type:

Promise <LoadContext()>

loadByScsFile

TreeLoader.loadByScsFile(config, parent, scsFilename)

Arguments:

• config (LoadSubtreeConfig()) – None
• parent (ProductOccurrence()) – None
• scsFilename (ScsUri) – None

Return type:

Promise <LoadContext()>

loadByStream

TreeLoader.loadByStream(config, parent, modelName)

Arguments:

• config (LoadSubtreeConfig()) – None
• parent (ProductOccurrence()) – None
• modelName (ScModelName()) – None

Return type:

Promise <LoadContext()>

loadByXmlDoc

TreeLoader.loadByXmlDoc(config, parent, xmlData, toAttachData)

Arguments:

• config (LoadSubtreeConfig()) – None
• parent (ProductOccurrence()) – None
• xmlData (string | Document()) – None
• toAttachData (VersionedToAttachDataFunc) – None

Return type:

Promise <LoadContext()>

loadByXmlFile

TreeLoader.loadByXmlFile(config, parent, xmlFilename, toAttachData)

Arguments:

• config (LoadSubtreeConfig()) – None
• parent (ProductOccurrence()) – None
• xmlFilename (XmlFilename) – None
• toAttachData (VersionedToAttachDataFunc) – None

Return type:

Promise <LoadContext()>

notifyDirectRequest

TreeLoader.notifyDirectRequest(node)

Arguments:

• node (ProductOccurrence()) – None

Return type:

void

onLoadChildProductOccurrence

TreeLoader.onLoadChildProductOccurrence()

Return type:ActionResult

reset

TreeLoader.reset()

Return type:Promise <void>

setPrefetchScsCutoffScale

TreeLoader.setPrefetchScsCutoffScale(prefetchCutoffScale)

Arguments:

• prefetchCutoffScale (number()) – None

Return type:

void

waitOnCurrentLoads

TreeLoader.waitOnCurrentLoads()

Return type:Promise <void>