BCFMarkup

class Communicator.BCFMarkup()

Constructors


Constructors

BCFMarkup.constructor(filename, document, bcfTopic)
Arguments
  • filename (string()) –

  • document (Document | null()) –

  • bcfTopic (BCFTopic()) –

Return type

BCFMarkup()

Methods

addComment

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

Adds a comment to the topic.

Arguments
  • date (Date()) –

  • author (string()) –

  • text (string()) –

  • viewpointGuid (string()) – optional

  • modifiedDate (Date()) – optional

  • modifiedAuthor (string()) – optional

Return type

BCFComment()

addViewpoint

BCFMarkup.addViewpoint(guid[, viewpointFilename[, snapshotFilename[, index]]])
Arguments
  • guid (Uuid) –

  • viewpointFilename (string()) – optional

  • snapshotFilename (string()) – optional

  • index (string()) – optional

Return type

void

deleteComment

BCFMarkup.deleteComment(guid)

Deletes a comment from the topic..

Arguments
Return type

void

export

BCFMarkup.export()
Return type

XMLDocument

Returns

XML document containing the markup data.

getBimDate

BCFMarkup.getBimDate()
Deprecated

Use getMarkupHeaderFiles instead.

Return type

Date | undefined

getBimFilename

BCFMarkup.getBimFilename()
Deprecated

Use getMarkupHeaderFiles instead.

Return type

string | undefined

getComments

BCFMarkup.getComments()

Gets a map of GUIDs and corresponding comments.

Return type

Map <Uuid, BCFComment()>

getFilename

BCFMarkup.getFilename()

Gets the Markup filename.

Return type

string

getIfcProject

BCFMarkup.getIfcProject()
Deprecated

Use getMarkupHeaderFiles instead.

Return type

GenericId | undefined

getIfcSpacialStructureElement

BCFMarkup.getIfcSpacialStructureElement()
Deprecated

Use getMarkupHeaderFiles instead.

Return type

GenericId | undefined

getIsExternal

BCFMarkup.getIsExternal()
Deprecated

Use getMarkupHeaderFiles instead.

Return type

boolean | undefined

getMarkupHeaderFiles

BCFMarkup.getMarkupHeaderFiles()
Return type

[BCFMarkupHeaderFile()]

Returns

a list of BCFMarkupHeaderFile containing data related to IFC files.

getProjectGuid

BCFMarkup.getProjectGuid()
Return type

Uuid | null

Returns

the project GUID.

getReference

BCFMarkup.getReference()
Deprecated

Use getMarkupHeaderFiles instead.

Return type

string | undefined

getTopicAssignedTo

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.

Return type

string | null

getTopicCreationAuthor

BCFMarkup.getTopicCreationAuthor()

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

Return type

string

getTopicCreationDate

BCFMarkup.getTopicCreationDate()

Gets the creation date of the markup topic.

Return type

Date

getTopicDescription

BCFMarkup.getTopicDescription()

Description of the topic.

Return type

string | null

getTopicDueDate

BCFMarkup.getTopicDueDate()

Date when the issue needs to be resolved by.

Return type

Date | null

getTopicId

BCFMarkup.getTopicId()

Gets the topic id.

Return type

Uuid

getTopicIndex

BCFMarkup.getTopicIndex()

Number to maintain the order of the topics.

Return type

number | null

getTopicLabels

BCFMarkup.getTopicLabels()

Tags for grouping Topics.

Return type

[string]

getTopicModifiedAuthor

BCFMarkup.getTopicModifiedAuthor()

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

Return type

string | null

getTopicModifiedDate

BCFMarkup.getTopicModifiedDate()

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

Return type

Date | null

getTopicPriority

BCFMarkup.getTopicPriority()

Gets the topic priority.

Return type

string | null

getTopicStage

BCFMarkup.getTopicStage()

Stage this topic is part of.

Return type

string | null

getTopicStatus

BCFMarkup.getTopicStatus()

Gets the topic status.

Return type

string | null

getTopicTitle

BCFMarkup.getTopicTitle()

Gets the title of the markup topic.

Return type

string

getTopicType

BCFMarkup.getTopicType()

Gets the topic type.

Return type

string | null

getViewpoints

BCFMarkup.getViewpoints()

Gets a map of GUIDs and corresponding viewpoints.

Return type

Map <Uuid, BCFMarkupViewpoint()>

setTopicAssignedTo

BCFMarkup.setTopicAssignedTo(assignedTo)

Sets the user that the topic is assigned to.

Arguments
  • assignedTo (string | null()) –

Return type

void

setTopicCreationAuthor

BCFMarkup.setTopicCreationAuthor(author)

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

Arguments
  • author (string()) –

Return type

void

setTopicCreationDate

BCFMarkup.setTopicCreationDate(date)

Sets the creation date of the markup topic;

Arguments
  • date (Date()) –

Return type

void

setTopicDescription

BCFMarkup.setTopicDescription(description)

Sets the topic description;

Arguments
  • description (string | null()) –

Return type

void

setTopicDueDate

BCFMarkup.setTopicDueDate(date)

Sets the topic due date.

Arguments
  • date (Date | null()) –

Return type

void

setTopicId

BCFMarkup.setTopicId(guid)

Sets the topic id.

Arguments
Return type

void

setTopicIndex

BCFMarkup.setTopicIndex(index)

Sets the topic index.

Arguments
  • index (number | null()) –

Return type

void

setTopicLabels

BCFMarkup.setTopicLabels(labels)

Sets the topic labels.

Arguments
  • labels ([string]()) –

Return type

void

setTopicModifiedAuthor

BCFMarkup.setTopicModifiedAuthor(modifiedAuthor)

Sets the author that last modified the topic.

Arguments
  • modifiedAuthor (string | null()) –

Return type

void

setTopicModifiedDate

BCFMarkup.setTopicModifiedDate(date)

Sets the topic modified date.

Arguments
  • date (Date | null()) –

Return type

void

setTopicPriority

BCFMarkup.setTopicPriority(priority)

Sets the topic priority.

Arguments
  • priority (string | null()) –

Return type

void

setTopicState

BCFMarkup.setTopicState(stage)

Sets the topic stage;

Arguments
  • stage (string | null()) –

Return type

void

setTopicStatus

BCFMarkup.setTopicStatus(topicStatus)

Sets the topic status.

Arguments
  • topicStatus (string | null()) –

Return type

void

setTopicTitle

BCFMarkup.setTopicTitle(title)

Sets the title of the markup topic.

Arguments
  • title (string()) –

Return type

void

setTopicType

BCFMarkup.setTopicType(topicType)

Sets the topic type.

Arguments
  • topicType (string | null()) –

Return type

void

updateComment

BCFMarkup.updateComment(comment)

Updates a topic comment.

Arguments
Return type

void