BCFData

class Bcf.BCFData()

This class contains data corresponding to the BCF file format.

Constructors

Methods

Constructors

BCFData.constructor(bcfFileName, id)
Arguments:
  • bcfFileName (string()) – None
  • id (number()) – None
Return type:

BCFData

Methods

addTopic

BCFData.addTopic(topicId, topic)
Arguments:
  • topicId (string()) – None
  • topic (BCFTopic()) – None

Adds a BCF topic.

Return type:void

exportBCF

BCFData.exportBCF(filename)
Arguments:
  • filename (string()) – Filename BCF data will be exported as

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

Return type:Promise <void>

getFilename

BCFData.getFilename()

Gets the BCF filename.

Return type:string

getId

BCFData.getId()

Identifier used to keep track of loaded BCF data.

Return type:number

getTopic

BCFData.getTopic(topicId)
Arguments:
  • topicId (string()) – None

Gets a BCF topic.

Return type:null | BCFTopic

getTopics

BCFData.getTopics()
Returns:A map associating BCF topic ids to BCF topic data.
Return type:Map <string, BCFTopic>

getVersion

BCFData.getVersion()

Gets the BCF version.

Return type:BCFVersion

setVersion

BCFData.setVersion(version)
Arguments:
  • version (BCFVersion()) – None

Sets the BCF version.

Return type:void

toBcfZipBlob

BCFData.toBcfZipBlob()

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

Return type:Promise <Blob>