
#########
BCFMarkup
#########

.. js:class:: Bcf.BCFMarkup

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Bcf.BCFMarkup.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Bcf.BCFMarkup.addComment`
   * :js:meth:`~Bcf.BCFMarkup.addViewpoint`
   * :js:meth:`~Bcf.BCFMarkup.deleteComment`
   * :js:meth:`~Bcf.BCFMarkup.export`
   * :js:meth:`~Bcf.BCFMarkup.getComments`
   * :js:meth:`~Bcf.BCFMarkup.getFilename`
   * :js:meth:`~Bcf.BCFMarkup.getMarkupHeaderFiles`
   * :js:meth:`~Bcf.BCFMarkup.getProjectGuid`
   * :js:meth:`~Bcf.BCFMarkup.getTopicAssignedTo`
   * :js:meth:`~Bcf.BCFMarkup.getTopicCreationAuthor`
   * :js:meth:`~Bcf.BCFMarkup.getTopicCreationDate`
   * :js:meth:`~Bcf.BCFMarkup.getTopicDescription`
   * :js:meth:`~Bcf.BCFMarkup.getTopicDueDate`
   * :js:meth:`~Bcf.BCFMarkup.getTopicId`
   * :js:meth:`~Bcf.BCFMarkup.getTopicIndex`
   * :js:meth:`~Bcf.BCFMarkup.getTopicLabels`
   * :js:meth:`~Bcf.BCFMarkup.getTopicModifiedAuthor`
   * :js:meth:`~Bcf.BCFMarkup.getTopicModifiedDate`
   * :js:meth:`~Bcf.BCFMarkup.getTopicPriority`
   * :js:meth:`~Bcf.BCFMarkup.getTopicReferenceLink`
   * :js:meth:`~Bcf.BCFMarkup.getTopicStage`
   * :js:meth:`~Bcf.BCFMarkup.getTopicStatus`
   * :js:meth:`~Bcf.BCFMarkup.getTopicTitle`
   * :js:meth:`~Bcf.BCFMarkup.getTopicType`
   * :js:meth:`~Bcf.BCFMarkup.getViewpoints`
   * :js:meth:`~Bcf.BCFMarkup.setTopicAssignedTo`
   * :js:meth:`~Bcf.BCFMarkup.setTopicCreationAuthor`
   * :js:meth:`~Bcf.BCFMarkup.setTopicCreationDate`
   * :js:meth:`~Bcf.BCFMarkup.setTopicDescription`
   * :js:meth:`~Bcf.BCFMarkup.setTopicDueDate`
   * :js:meth:`~Bcf.BCFMarkup.setTopicId`
   * :js:meth:`~Bcf.BCFMarkup.setTopicIndex`
   * :js:meth:`~Bcf.BCFMarkup.setTopicLabels`
   * :js:meth:`~Bcf.BCFMarkup.setTopicModifiedAuthor`
   * :js:meth:`~Bcf.BCFMarkup.setTopicModifiedDate`
   * :js:meth:`~Bcf.BCFMarkup.setTopicPriority`
   * :js:meth:`~Bcf.BCFMarkup.setTopicReferenceLink`
   * :js:meth:`~Bcf.BCFMarkup.setTopicState`
   * :js:meth:`~Bcf.BCFMarkup.setTopicStatus`
   * :js:meth:`~Bcf.BCFMarkup.setTopicTitle`
   * :js:meth:`~Bcf.BCFMarkup.setTopicType`
   * :js:meth:`~Bcf.BCFMarkup.updateComment`
   
   




Constructors
============

.. js:method:: Bcf.BCFMarkup.constructor

   .. rst-class:: sig-pretty-signature
   
      | BCFMarkup(**filename**\ : *string*\ , **document**\ : (*None* \| *Document*\ ), **bcfTopic**\ : :js:class:`BCFTopic <Bcf.BCFTopic>`\ ): :js:class:`BCFMarkup <Bcf.BCFMarkup>`
   
   **Parameters**
   
      **filename**\ : *string*
   
      **document**\ : (*None* \| *Document*\ )
   
      **bcfTopic**\ : :js:class:`BCFTopic <Bcf.BCFTopic>`
   
   
   **Returns**\ : :js:class:`BCFMarkup <Bcf.BCFMarkup>`
   





Methods
=======

.. js:method:: Bcf.BCFMarkup.addComment

   .. rst-class:: sig-pretty-signature
   
      | addComment(**date**\ : *Date*\ , **author**\ : *string*\ , **text**\ : *string*\ , **viewpointGuid**\ : *string*\ , **modifiedDate**\ : *Date*\ , **modifiedAuthor**\ : *string*\ ): :js:class:`BCFComment <Bcf.BCFComment>`
   
   Adds a comment to the topic.
   
   **Parameters**
   
      **date**\ : *Date*
   
      **author**\ : *string*
   
      **text**\ : *string*
   
      **viewpointGuid**\ : *string*
   
      **modifiedDate**\ : *Date*
   
      **modifiedAuthor**\ : *string*
   
   
   **Returns**\ : :js:class:`BCFComment <Bcf.BCFComment>`
   



.. js:method:: Bcf.BCFMarkup.addViewpoint

   .. rst-class:: sig-pretty-signature
   
      | addViewpoint(**guid**\ : *string*\ , **viewpointFilename**\ : *string*\ , **snapshotFilename**\ : *string*\ , **index**\ : *string*\ ): *void*
   
   **Parameters**
   
      **guid**\ : *string*
   
      **viewpointFilename**\ : *string*
   
      **snapshotFilename**\ : *string*
   
      **index**\ : *string*
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.deleteComment

   .. rst-class:: sig-pretty-signature
   
      | deleteComment(**guid**\ : *string*\ ): *void*
   
   Deletes a comment from the topic..
   
   **Parameters**
   
      **guid**\ : *string*
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.export

   .. rst-class:: sig-pretty-signature
   
      | export(): *XMLDocument*
   
   **Returns**\ : *XMLDocument*
   
      XML document containing the markup data.
   
   



.. js:method:: Bcf.BCFMarkup.getComments

   .. rst-class:: sig-pretty-signature
   
      | getComments(): *Map*
   
   Gets a map of GUIDs and corresponding comments.
   
   **Returns**\ : *Map*
   



.. js:method:: Bcf.BCFMarkup.getFilename

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



.. js:method:: Bcf.BCFMarkup.getMarkupHeaderFiles

   .. rst-class:: sig-pretty-signature
   
      | getMarkupHeaderFiles(): :js:class:`BCFMarkupHeaderFile <Bcf.BCFMarkupHeaderFile>`\ []
   
   **Returns**\ : :js:class:`BCFMarkupHeaderFile <Bcf.BCFMarkupHeaderFile>`\ []
   
      a list of [[BCFMarkupHeaderFile]] containing data related to IFC files.
   
   



.. js:method:: Bcf.BCFMarkup.getProjectGuid

   .. rst-class:: sig-pretty-signature
   
      | getProjectGuid(): (*None* \| *string*\ )
   
   **Returns**\ : (*None* \| *string*\ )
   
      the project GUID.
   
   



.. js:method:: Bcf.BCFMarkup.getTopicAssignedTo

   .. rst-class:: sig-pretty-signature
   
      | getTopicAssignedTo(): (*None* \| *string*\ )
   
   The user to whom this topic is assigned to. Recommended to be in email format. The list of possible values are defined in the extension schema.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicCreationAuthor

   .. rst-class:: sig-pretty-signature
   
      | getTopicCreationAuthor(): *string*
   
   Gets the name of the user that created the markup topic.
   
   **Returns**\ : *string*
   



.. js:method:: Bcf.BCFMarkup.getTopicCreationDate

   .. rst-class:: sig-pretty-signature
   
      | getTopicCreationDate(): *Date*
   
   Gets the creation date of the markup topic.
   
   **Returns**\ : *Date*
   



.. js:method:: Bcf.BCFMarkup.getTopicDescription

   .. rst-class:: sig-pretty-signature
   
      | getTopicDescription(): (*None* \| *string*\ )
   
   Description of the topic.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicDueDate

   .. rst-class:: sig-pretty-signature
   
      | getTopicDueDate(): (*None* \| *Date*\ )
   
   Date when the issue needs to be resolved by.
   
   **Returns**\ : (*None* \| *Date*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicId

   .. rst-class:: sig-pretty-signature
   
      | getTopicId(): *string*
   
   Gets the topic id.
   
   **Returns**\ : *string*
   



.. js:method:: Bcf.BCFMarkup.getTopicIndex

   .. rst-class:: sig-pretty-signature
   
      | getTopicIndex(): (*None* \| *number*\ )
   
   Number to maintain the order of the topics.
   
   **Returns**\ : (*None* \| *number*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicLabels

   .. rst-class:: sig-pretty-signature
   
      | getTopicLabels(): *string*\ []
   
   Tags for grouping Topics.
   
   **Returns**\ : *string*\ []
   



.. js:method:: Bcf.BCFMarkup.getTopicModifiedAuthor

   .. rst-class:: sig-pretty-signature
   
      | getTopicModifiedAuthor(): (*None* \| *string*\ )
   
   User who modified the topic. Exists only when Topic has been modified after creation.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicModifiedDate

   .. rst-class:: sig-pretty-signature
   
      | getTopicModifiedDate(): (*None* \| *Date*\ )
   
   Date when the topic was last modified. Exists only when Topic has been modified after creation.
   
   **Returns**\ : (*None* \| *Date*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicPriority

   .. rst-class:: sig-pretty-signature
   
      | getTopicPriority(): (*None* \| *string*\ )
   
   Gets the topic priority.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicReferenceLink

   .. rst-class:: sig-pretty-signature
   
      | getTopicReferenceLink(): (*None* \| *string*\ )
   
   List of references to the topic, for example, a work request management system or an URI to a model.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicStage

   .. rst-class:: sig-pretty-signature
   
      | getTopicStage(): (*None* \| *string*\ )
   
   Stage this topic is part of.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicStatus

   .. rst-class:: sig-pretty-signature
   
      | getTopicStatus(): (*None* \| *string*\ )
   
   Gets the topic status.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkup.getTopicTitle

   .. rst-class:: sig-pretty-signature
   
      | getTopicTitle(): *string*
   
   Gets the title of the markup topic.
   
   **Returns**\ : *string*
   



.. js:method:: Bcf.BCFMarkup.getTopicType

   .. rst-class:: sig-pretty-signature
   
      | getTopicType(): (*None* \| *string*\ )
   
   Gets the topic type.
   
   **Returns**\ : (*None* \| *string*\ )
   



.. js:method:: Bcf.BCFMarkup.getViewpoints

   .. rst-class:: sig-pretty-signature
   
      | getViewpoints(): *Map*
   
   Gets a map of GUIDs and corresponding viewpoints.
   
   **Returns**\ : *Map*
   



.. js:method:: Bcf.BCFMarkup.setTopicAssignedTo

   .. rst-class:: sig-pretty-signature
   
      | setTopicAssignedTo(**assignedTo**\ : (*None* \| *string*\ )): *void*
   
   Sets the user that the topic is assigned to.
   
   **Parameters**
   
      **assignedTo**\ : (*None* \| *string*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicCreationAuthor

   .. rst-class:: sig-pretty-signature
   
      | setTopicCreationAuthor(**author**\ : *string*\ ): *void*
   
   Sets the name of the user that created the markup topic.
   
   **Parameters**
   
      **author**\ : *string*
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicCreationDate

   .. rst-class:: sig-pretty-signature
   
      | setTopicCreationDate(**date**\ : *Date*\ ): *void*
   
   Sets the creation date of the markup topic;
   
   **Parameters**
   
      **date**\ : *Date*
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicDescription

   .. rst-class:: sig-pretty-signature
   
      | setTopicDescription(**description**\ : (*None* \| *string*\ )): *void*
   
   Sets the topic description;
   
   **Parameters**
   
      **description**\ : (*None* \| *string*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicDueDate

   .. rst-class:: sig-pretty-signature
   
      | setTopicDueDate(**date**\ : (*None* \| *Date*\ )): *void*
   
   Sets the topic due date.
   
   **Parameters**
   
      **date**\ : (*None* \| *Date*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicId

   .. rst-class:: sig-pretty-signature
   
      | setTopicId(**guid**\ : *string*\ ): *void*
   
   Sets the topic id.
   
   **Parameters**
   
      **guid**\ : *string*
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicIndex

   .. rst-class:: sig-pretty-signature
   
      | setTopicIndex(**index**\ : (*None* \| *number*\ )): *void*
   
   Sets the topic index.
   
   **Parameters**
   
      **index**\ : (*None* \| *number*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicLabels

   .. rst-class:: sig-pretty-signature
   
      | setTopicLabels(**labels**\ : *string*\ []): *void*
   
   Sets the topic labels.
   
   **Parameters**
   
      **labels**\ : *string*\ []
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicModifiedAuthor

   .. rst-class:: sig-pretty-signature
   
      | setTopicModifiedAuthor(**modifiedAuthor**\ : (*None* \| *string*\ )): *void*
   
   Sets the author that last modified the topic.
   
   **Parameters**
   
      **modifiedAuthor**\ : (*None* \| *string*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicModifiedDate

   .. rst-class:: sig-pretty-signature
   
      | setTopicModifiedDate(**date**\ : (*None* \| *Date*\ )): *void*
   
   Sets the topic modified date.
   
   **Parameters**
   
      **date**\ : (*None* \| *Date*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicPriority

   .. rst-class:: sig-pretty-signature
   
      | setTopicPriority(**priority**\ : (*None* \| *string*\ )): *void*
   
   Sets the topic priority.
   
   **Parameters**
   
      **priority**\ : (*None* \| *string*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicReferenceLink

   .. rst-class:: sig-pretty-signature
   
      | setTopicReferenceLink(**referenceLink**\ : (*None* \| *string*\ )): *void*
   
   Sets the ReferenceLink.
   
   **Parameters**
   
      **referenceLink**\ : (*None* \| *string*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicState

   .. rst-class:: sig-pretty-signature
   
      | setTopicState(**stage**\ : (*None* \| *string*\ )): *void*
   
   Sets the topic stage;
   
   **Parameters**
   
      **stage**\ : (*None* \| *string*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicStatus

   .. rst-class:: sig-pretty-signature
   
      | setTopicStatus(**topicStatus**\ : (*None* \| *string*\ )): *void*
   
   Sets the topic status.
   
   **Parameters**
   
      **topicStatus**\ : (*None* \| *string*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicTitle

   .. rst-class:: sig-pretty-signature
   
      | setTopicTitle(**title**\ : *string*\ ): *void*
   
   Sets the title of the markup topic.
   
   **Parameters**
   
      **title**\ : *string*
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.setTopicType

   .. rst-class:: sig-pretty-signature
   
      | setTopicType(**topicType**\ : (*None* \| *string*\ )): *void*
   
   Sets the topic type.
   
   **Parameters**
   
      **topicType**\ : (*None* \| *string*\ )
   
   
   **Returns**\ : *void*
   



.. js:method:: Bcf.BCFMarkup.updateComment

   .. rst-class:: sig-pretty-signature
   
      | updateComment(**comment**\ : :js:class:`BCFComment <Bcf.BCFComment>`\ ): *void*
   
   Updates a topic comment.
   
   **Parameters**
   
      **comment**\ : :js:class:`BCFComment <Bcf.BCFComment>`
   
   
   **Returns**\ : *void*
   





