BCFTopic

class BCFTopic()

Constructors

constructor()

Methods

addMarkup()
addSnapshot()
addViewpoint()
getMarkup()
getSnapshot()
getSnapshotMap()
getTopicId()
getViewpoint()
getViewpointMap()
setSnapshot()
setViewpoint()
createTopic()

Constructors

BCFTopic.constructor(bcfDataId, bcfFilename, topicId, viewer)

Arguments:	bcfDataId (`number()`) – None bcfFilename (BCFName) – None topicId (BCFTopicId) – None viewer (`IWebViewer()`) – None
Return type:	`BCFTopic()`

Methods

addMarkup

BCFTopic.addMarkup(filename, document)

Arguments:	filename (`string()`) – None document (`Document \| null()`) – None
Return type:	`BCFMarkup()`

addSnapshot

BCFTopic.addSnapshot(filename, png)

Arguments:	filename (`string()`) – None png (`Uint8Array()`) –
Return type:	void

addViewpoint

BCFTopic.addViewpoint(filename, document, version, modelBounding, modelUnits)

Arguments:	filename (`string()`) – None document (`Document \| null()`) – None version (BCFVersion) – None modelBounding (`Box()`) – None modelUnits (`number()`) – None
Return type:	`BCFViewpoint()`

getMarkup

BCFTopic.getMarkup()

Return type:	`BCFMarkup()`

getSnapshot

BCFTopic.getSnapshot(filename)

Arguments:	filename (`string()`) –
Return type:	`BCFSnapshot()` \| null

getSnapshotMap

BCFTopic.getSnapshotMap()

Return type:	Map <string, `BCFSnapshot()`>

getTopicId

BCFTopic.getTopicId()

Return type:	BCFTopicId

getViewpoint

BCFTopic.getViewpoint(filename)

Arguments:	filename (`string()`) –
Return type:	`BCFViewpoint()` \| null

getViewpointMap

BCFTopic.getViewpointMap()

Return type:	Map <string, `BCFViewpoint()`>

setSnapshot

BCFTopic.setSnapshot(filename, snapshot)

Arguments:	filename (`string()`) – snapshot (`BCFSnapshot()`) –
Return type:	void

setViewpoint

BCFTopic.setViewpoint(filename, viewpoint)

Arguments:	filename (`string()`) – viewpoint (`BCFViewpoint()`) –
Return type:	void

static createTopic

BCFTopic.createTopic(viewer, bcfDataId, bcfFilename, topicTitle, markupView)

Arguments:	viewer (`IWebViewer()`) – bcfDataId (`number()`) – bcfFilename (BCFName) – topicTitle (`string()`) – markupView (`MarkupView()` \| null) –
Return type:	Promise <`BCFTopic()`>