BCFData

class Bcf.BCFData()

This class contains data corresponding to the BCF file format.

Constructors

Bcf.BCFData.constructor()
BCFData(bcfFileName: string, id: number): BCFData

Parameters

bcfFileName: string

id: number

Returns: BCFData

Methods

Bcf.BCFData.addTopic()
addTopic(topicId: string, topic: BCFTopic): void

Adds a BCF topic.

Parameters

topicId: string

topic: BCFTopic

Returns: void

Bcf.BCFData.exportBCF()
exportBCF(filename: string): Promise

Exports BCF data to a file. Prompts the user to save it on their device.

Parameters

filename: string

Filename BCF data will be exported as

Returns: Promise

Bcf.BCFData.getFilename()
getFilename(): string

Gets the BCF filename.

Returns: string

Bcf.BCFData.getId()
getId(): number

Identifier used to keep track of loaded BCF data.

Returns: number

Bcf.BCFData.getTopic()
getTopic(topicId: string): (None | BCFTopic)

Gets a BCF topic.

Parameters

topicId: string

Returns: (None | BCFTopic)

Bcf.BCFData.getTopics()
getTopics(): Map

Returns: Map

A map associating BCF topic ids to BCF topic data.
Bcf.BCFData.getVersion()
getVersion(): BCFVersion

Gets the BCF version.

Returns: BCFVersion

Bcf.BCFData.setVersion()
setVersion(version: BCFVersion): void

Sets the BCF version.

Parameters

version: BCFVersion

Returns: void

Bcf.BCFData.toBcfZipBlob()
toBcfZipBlob(): Promise

Creates a BCFZIP blob. The resulting blob is importable using BcfManager.addBCFFromBuffer.

Returns: Promise