BCFMarkup
- class Communicator.BCFMarkup()
Constructors
Methods
Constructors
- BCFMarkup.constructor(filename, document, bcfTopic)
- Arguments
filename (
string()
) –document (
Document | null()
) –bcfTopic (
BCFTopic()
) –
- Return type
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()
) – optionalmodifiedDate (
Date()
) – optionalmodifiedAuthor (
string()
) – optional
- Return type
addViewpoint
deleteComment
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
getIfcSpacialStructureElement
getIsExternal
- BCFMarkup.getIsExternal()
- Deprecated
Use
getMarkupHeaderFiles
instead.- Return type
boolean | undefined
getMarkupHeaderFiles
- BCFMarkup.getMarkupHeaderFiles()
- Return type
- Returns
a list of
BCFMarkupHeaderFile
containing data related to IFC files.
getProjectGuid
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
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
getTopicReferenceLink
- BCFMarkup.getTopicReferenceLink()
List of references to the topic, for example, a work request management system or an URI to a model.
- 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
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
setTopicReferenceLink
- BCFMarkup.setTopicReferenceLink(referenceLink)
Sets the ReferenceLink.
- Arguments
referenceLink (
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
comment (
BCFComment()
) –
- Return type
void