
#######
BCFData
#######

.. js:class:: wv.Bcf.BCFData

   This class contains data corresponding to the BCF file format.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wv.Bcf.BCFData.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Bcf.BCFData.addTopic`
   * :js:meth:`~wv.Bcf.BCFData.exportBCF`
   * :js:meth:`~wv.Bcf.BCFData.getFilename`
   * :js:meth:`~wv.Bcf.BCFData.getId`
   * :js:meth:`~wv.Bcf.BCFData.getTopic`
   * :js:meth:`~wv.Bcf.BCFData.getTopics`
   * :js:meth:`~wv.Bcf.BCFData.getVersion`
   * :js:meth:`~wv.Bcf.BCFData.setVersion`
   * :js:meth:`~wv.Bcf.BCFData.toBcfZipBlob`
   
   



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: wv.Bcf.BCFData.constructor

      .. rst-class:: sig-pretty-signature
      
         | BCFData(**bcfFileName**\ : *string*\ , **id**\ : *number*\ ): :js:class:`BCFData <wv.Bcf.BCFData>`
      
      **Parameters**
      
      
         **bcfFileName**\ : *string*
      
         **id**\ : *number*
      
      
      **Returns**\ : :js:class:`BCFData <wv.Bcf.BCFData>`
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: wv.Bcf.BCFData.addTopic

      .. rst-class:: sig-pretty-signature
      
         | addTopic(**topicId**\ : *string*\ , **topic**\ : :js:class:`BCFTopic <wv.Bcf.BCFTopic>`\ ): *void*
      
      Adds a BCF topic.
      
      **Parameters**
      
      
         **topicId**\ : *string*
      
         **topic**\ : :js:class:`BCFTopic <wv.Bcf.BCFTopic>`
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Bcf.BCFData.exportBCF

      .. rst-class:: sig-pretty-signature
      
         | 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*
      



.. js:method:: wv.Bcf.BCFData.getFilename

      .. rst-class:: sig-pretty-signature
      
         | getFilename(): *string*
      
      Gets the BCF filename.
      
      **Returns**\ : *string*
      



.. js:method:: wv.Bcf.BCFData.getId

      .. rst-class:: sig-pretty-signature
      
         | getId(): *number*
      
      Identifier used to keep track of loaded BCF data.
      
      **Returns**\ : *number*
      



.. js:method:: wv.Bcf.BCFData.getTopic

      .. rst-class:: sig-pretty-signature
      
         | getTopic(**topicId**\ : *string*\ ): (*None* | :js:class:`BCFTopic <wv.Bcf.BCFTopic>`\ )
      
      Gets a BCF topic.
      
      **Parameters**
      
      
         **topicId**\ : *string*
      
      
      **Returns**\ : (*None* \| :js:class:`BCFTopic <wv.Bcf.BCFTopic>`\ )
      



.. js:method:: wv.Bcf.BCFData.getTopics

      .. rst-class:: sig-pretty-signature
      
         | getTopics(): *Map*
      
      **Returns**\ : *Map*
      
      
         A map associating BCF topic ids to BCF topic data.
      
      



.. js:method:: wv.Bcf.BCFData.getVersion

      .. rst-class:: sig-pretty-signature
      
         | getVersion(): :js:data:`BCFVersion <wv.Bcf.BCFVersion>`
      
      Gets the BCF version.
      
      **Returns**\ : :js:data:`BCFVersion <wv.Bcf.BCFVersion>`
      



.. js:method:: wv.Bcf.BCFData.setVersion

      .. rst-class:: sig-pretty-signature
      
         | setVersion(**version**\ : :js:data:`BCFVersion <wv.Bcf.BCFVersion>`\ ): *void*
      
      Sets the BCF version.
      
      **Parameters**
      
      
         **version**\ : :js:data:`BCFVersion <wv.Bcf.BCFVersion>`
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Bcf.BCFData.toBcfZipBlob

      .. rst-class:: sig-pretty-signature
      
         | toBcfZipBlob(): *Promise*
      
      Creates a BCFZIP blob. The resulting blob is importable using ``BcfManager.addBCFFromBuffer``\ .
      
      **Returns**\ : *Promise*
      




