.. role:: ts-api-decorator

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

.. js:module:: Bcf
   :noindex:

.. container:: ts-api-section

   .. js:class:: BCFMarkup



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~Bcf.BCFMarkup.constructor`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :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
============

.. container:: ts-api-section

   .. js:function:: BCFMarkup.constructor( filename, document, bcfTopic)

      :param filename: None
      :type filename: string
      :param document: None
      :type document: null | Document
      :param bcfTopic: None
      :type bcfTopic: BCFTopic


      :rtype: BCFMarkup



Methods
=======

.. rst-class:: ts-api-section

addComment
----------

.. js:method:: BCFMarkup.addComment( date, author, text[, viewpointGuid[, modifiedDate[, modifiedAuthor]]])

   :param date: None
   :type date: Date
   :param author: None
   :type author: string
   :param text: None
   :type text: string
   :param viewpointGuid: :ts-api-decorator:`optional` None
   :type viewpointGuid: string
   :param modifiedDate: :ts-api-decorator:`optional` None
   :type modifiedDate: Date
   :param modifiedAuthor: :ts-api-decorator:`optional` None
   :type modifiedAuthor: string


   Adds a comment to the topic.


   :rtype: BCFComment

.. rst-class:: ts-api-section

addViewpoint
------------

.. js:method:: BCFMarkup.addViewpoint( guid[, viewpointFilename[, snapshotFilename[, index]]])

   :param guid: None
   :type guid: string
   :param viewpointFilename: :ts-api-decorator:`optional` None
   :type viewpointFilename: string
   :param snapshotFilename: :ts-api-decorator:`optional` None
   :type snapshotFilename: string
   :param index: :ts-api-decorator:`optional` None
   :type index: string


   :rtype: void

.. rst-class:: ts-api-section

deleteComment
-------------

.. js:method:: BCFMarkup.deleteComment( guid)

   :param guid: None
   :type guid: string


   Deletes a comment from the topic..


   :rtype: void

.. rst-class:: ts-api-section

export
------

.. js:method:: BCFMarkup.export()





   :returns: XML document containing the markup data.


   :rtype: XMLDocument

.. rst-class:: ts-api-section

getComments
-----------

.. js:method:: BCFMarkup.getComments()



   Gets a map of GUIDs and corresponding comments.


   :rtype: Map <string, BCFComment>

.. rst-class:: ts-api-section

getFilename
-----------

.. js:method:: BCFMarkup.getFilename()



   Gets the Markup filename.


   :rtype: string

.. rst-class:: ts-api-section

getMarkupHeaderFiles
--------------------

.. js:method:: BCFMarkup.getMarkupHeaderFiles()





   :returns: a list of [[BCFMarkupHeaderFile]] containing data related to IFC files.


   :rtype: [BCFMarkupHeaderFile]

.. rst-class:: ts-api-section

getProjectGuid
--------------

.. js:method:: BCFMarkup.getProjectGuid()





   :returns: the project GUID.


   :rtype: null | string

.. rst-class:: ts-api-section

getTopicAssignedTo
------------------

.. js:method:: BCFMarkup.getTopicAssignedTo()



   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.


   :rtype: null | string

.. rst-class:: ts-api-section

getTopicCreationAuthor
----------------------

.. js:method:: BCFMarkup.getTopicCreationAuthor()



   Gets the name of the user that created the markup topic.


   :rtype: string

.. rst-class:: ts-api-section

getTopicCreationDate
--------------------

.. js:method:: BCFMarkup.getTopicCreationDate()



   Gets the creation date of the markup topic.


   :rtype: Date

.. rst-class:: ts-api-section

getTopicDescription
-------------------

.. js:method:: BCFMarkup.getTopicDescription()



   Description of the topic.


   :rtype: null | string

.. rst-class:: ts-api-section

getTopicDueDate
---------------

.. js:method:: BCFMarkup.getTopicDueDate()



   Date when the issue needs to be resolved by.


   :rtype: null | Date

.. rst-class:: ts-api-section

getTopicId
----------

.. js:method:: BCFMarkup.getTopicId()



   Gets the topic id.


   :rtype: string

.. rst-class:: ts-api-section

getTopicIndex
-------------

.. js:method:: BCFMarkup.getTopicIndex()



   Number to maintain the order of the topics.


   :rtype: null | number

.. rst-class:: ts-api-section

getTopicLabels
--------------

.. js:method:: BCFMarkup.getTopicLabels()



   Tags for grouping Topics.


   :rtype: [string]

.. rst-class:: ts-api-section

getTopicModifiedAuthor
----------------------

.. js:method:: BCFMarkup.getTopicModifiedAuthor()



   User who modified the topic. Exists only when Topic has been modified after creation.


   :rtype: null | string

.. rst-class:: ts-api-section

getTopicModifiedDate
--------------------

.. js:method:: BCFMarkup.getTopicModifiedDate()



   Date when the topic was last modified. Exists only when Topic has been modified after creation.


   :rtype: null | Date

.. rst-class:: ts-api-section

getTopicPriority
----------------

.. js:method:: BCFMarkup.getTopicPriority()



   Gets the topic priority.


   :rtype: null | string

.. rst-class:: ts-api-section

getTopicReferenceLink
---------------------

.. js:method:: BCFMarkup.getTopicReferenceLink()



   List of references to the topic, for example, a work request management system or an URI to a model.


   :rtype: null | string

.. rst-class:: ts-api-section

getTopicStage
-------------

.. js:method:: BCFMarkup.getTopicStage()



   Stage this topic is part of.


   :rtype: null | string

.. rst-class:: ts-api-section

getTopicStatus
--------------

.. js:method:: BCFMarkup.getTopicStatus()



   Gets the topic status.


   :rtype: null | string

.. rst-class:: ts-api-section

getTopicTitle
-------------

.. js:method:: BCFMarkup.getTopicTitle()



   Gets the title of the markup topic.


   :rtype: string

.. rst-class:: ts-api-section

getTopicType
------------

.. js:method:: BCFMarkup.getTopicType()



   Gets the topic type.


   :rtype: null | string

.. rst-class:: ts-api-section

getViewpoints
-------------

.. js:method:: BCFMarkup.getViewpoints()



   Gets a map of GUIDs and corresponding viewpoints.


   :rtype: Map <string, BCFMarkupViewpoint>

.. rst-class:: ts-api-section

setTopicAssignedTo
------------------

.. js:method:: BCFMarkup.setTopicAssignedTo( assignedTo)

   :param assignedTo: None
   :type assignedTo: null | string


   Sets the user that the topic is assigned to.


   :rtype: void

.. rst-class:: ts-api-section

setTopicCreationAuthor
----------------------

.. js:method:: BCFMarkup.setTopicCreationAuthor( author)

   :param author: None
   :type author: string


   Sets the name of the user that created the markup topic.


   :rtype: void

.. rst-class:: ts-api-section

setTopicCreationDate
--------------------

.. js:method:: BCFMarkup.setTopicCreationDate( date)

   :param date: None
   :type date: Date


   Sets the creation date of the markup topic;


   :rtype: void

.. rst-class:: ts-api-section

setTopicDescription
-------------------

.. js:method:: BCFMarkup.setTopicDescription( description)

   :param description: None
   :type description: null | string


   Sets the topic description;


   :rtype: void

.. rst-class:: ts-api-section

setTopicDueDate
---------------

.. js:method:: BCFMarkup.setTopicDueDate( date)

   :param date: None
   :type date: null | Date


   Sets the topic due date.


   :rtype: void

.. rst-class:: ts-api-section

setTopicId
----------

.. js:method:: BCFMarkup.setTopicId( guid)

   :param guid: None
   :type guid: string


   Sets the topic id.


   :rtype: void

.. rst-class:: ts-api-section

setTopicIndex
-------------

.. js:method:: BCFMarkup.setTopicIndex( index)

   :param index: None
   :type index: null | number


   Sets the topic index.


   :rtype: void

.. rst-class:: ts-api-section

setTopicLabels
--------------

.. js:method:: BCFMarkup.setTopicLabels( labels)

   :param labels: None
   :type labels: [string]


   Sets the topic labels.


   :rtype: void

.. rst-class:: ts-api-section

setTopicModifiedAuthor
----------------------

.. js:method:: BCFMarkup.setTopicModifiedAuthor( modifiedAuthor)

   :param modifiedAuthor: None
   :type modifiedAuthor: null | string


   Sets the author that last modified the topic.


   :rtype: void

.. rst-class:: ts-api-section

setTopicModifiedDate
--------------------

.. js:method:: BCFMarkup.setTopicModifiedDate( date)

   :param date: None
   :type date: null | Date


   Sets the topic modified date.


   :rtype: void

.. rst-class:: ts-api-section

setTopicPriority
----------------

.. js:method:: BCFMarkup.setTopicPriority( priority)

   :param priority: None
   :type priority: null | string


   Sets the topic priority.


   :rtype: void

.. rst-class:: ts-api-section

setTopicReferenceLink
---------------------

.. js:method:: BCFMarkup.setTopicReferenceLink( referenceLink)

   :param referenceLink: None
   :type referenceLink: null | string


   Sets the ReferenceLink.


   :rtype: void

.. rst-class:: ts-api-section

setTopicState
-------------

.. js:method:: BCFMarkup.setTopicState( stage)

   :param stage: None
   :type stage: null | string


   Sets the topic stage;


   :rtype: void

.. rst-class:: ts-api-section

setTopicStatus
--------------

.. js:method:: BCFMarkup.setTopicStatus( topicStatus)

   :param topicStatus: None
   :type topicStatus: null | string


   Sets the topic status.


   :rtype: void

.. rst-class:: ts-api-section

setTopicTitle
-------------

.. js:method:: BCFMarkup.setTopicTitle( title)

   :param title: None
   :type title: string


   Sets the title of the markup topic.


   :rtype: void

.. rst-class:: ts-api-section

setTopicType
------------

.. js:method:: BCFMarkup.setTopicType( topicType)

   :param topicType: None
   :type topicType: null | string


   Sets the topic type.


   :rtype: void

.. rst-class:: ts-api-section

updateComment
-------------

.. js:method:: BCFMarkup.updateComment( comment)

   :param comment: None
   :type comment: BCFComment


   Updates a topic comment.


   :rtype: void

