BCFMarkup

class Bcf.BCFMarkup()

Index

Constructors

• constructor

Methods

• addComment
• addViewpoint
• deleteComment
• export
• getComments
• getFilename
• getMarkupHeaderFiles
• getProjectGuid
• getTopicAssignedTo
• getTopicCreationAuthor
• getTopicCreationDate
• getTopicDescription
• getTopicDueDate
• getTopicId
• getTopicIndex
• getTopicLabels
• getTopicModifiedAuthor
• getTopicModifiedDate
• getTopicPriority
• getTopicReferenceLink
• getTopicStage
• getTopicStatus
• getTopicTitle
• getTopicType
• getViewpoints
• setTopicAssignedTo
• setTopicCreationAuthor
• setTopicCreationDate
• setTopicDescription
• setTopicDueDate
• setTopicId
• setTopicIndex
• setTopicLabels
• setTopicModifiedAuthor
• setTopicModifiedDate
• setTopicPriority
• setTopicReferenceLink
• setTopicState
• setTopicStatus
• setTopicTitle
• setTopicType
• updateComment

Constructors

Bcf.BCFMarkup.constructor()

BCFMarkup(filename: string, document: (None | Document), bcfTopic: BCFTopic): BCFMarkup

Parameters

filename: string

document: (None | Document)

bcfTopic: BCFTopic

Returns: BCFMarkup

Methods

Bcf.BCFMarkup.addComment()

addComment(date: Date, author: string, text: string, viewpointGuid: string, modifiedDate: Date, modifiedAuthor: string): BCFComment

Adds a comment to the topic.

Parameters

date: Date

author: string

text: string

viewpointGuid: string

modifiedDate: Date

modifiedAuthor: string

Returns: BCFComment

Bcf.BCFMarkup.addViewpoint()

addViewpoint(guid: string, viewpointFilename: string, snapshotFilename: string, index: string): void

Parameters

guid: string

viewpointFilename: string

snapshotFilename: string

index: string

Returns: void

Bcf.BCFMarkup.deleteComment()

deleteComment(guid: string): void

Deletes a comment from the topic..

Parameters

guid: string

Returns: void

Bcf.BCFMarkup.export()

export(): XMLDocument

Returns: XMLDocument

XML document containing the markup data.

Bcf.BCFMarkup.getComments()

getComments(): Map

Gets a map of GUIDs and corresponding comments.

Returns: Map

Bcf.BCFMarkup.getFilename()

getFilename(): string

Gets the Markup filename.

Returns: string

Bcf.BCFMarkup.getMarkupHeaderFiles()

getMarkupHeaderFiles(): BCFMarkupHeaderFile[]

Returns: BCFMarkupHeaderFile[]

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

Bcf.BCFMarkup.getProjectGuid()

getProjectGuid(): (None | string)

Returns: (None | string)

the project GUID.

Bcf.BCFMarkup.getTopicAssignedTo()

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)

Bcf.BCFMarkup.getTopicCreationAuthor()

getTopicCreationAuthor(): string

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

Returns: string

Bcf.BCFMarkup.getTopicCreationDate()

getTopicCreationDate(): Date

Gets the creation date of the markup topic.

Returns: Date

Bcf.BCFMarkup.getTopicDescription()

getTopicDescription(): (None | string)

Description of the topic.

Returns: (None | string)

Bcf.BCFMarkup.getTopicDueDate()

getTopicDueDate(): (None | Date)

Date when the issue needs to be resolved by.

Returns: (None | Date)

Bcf.BCFMarkup.getTopicId()

getTopicId(): string

Gets the topic id.

Returns: string

Bcf.BCFMarkup.getTopicIndex()

getTopicIndex(): (None | number)

Number to maintain the order of the topics.

Returns: (None | number)

Bcf.BCFMarkup.getTopicLabels()

getTopicLabels(): string[]

Tags for grouping Topics.

Returns: string[]

Bcf.BCFMarkup.getTopicModifiedAuthor()

getTopicModifiedAuthor(): (None | string)

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

Returns: (None | string)

Bcf.BCFMarkup.getTopicModifiedDate()

getTopicModifiedDate(): (None | Date)

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

Returns: (None | Date)

Bcf.BCFMarkup.getTopicPriority()

getTopicPriority(): (None | string)

Gets the topic priority.

Returns: (None | string)

Bcf.BCFMarkup.getTopicReferenceLink()

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)

Bcf.BCFMarkup.getTopicStage()

getTopicStage(): (None | string)

Stage this topic is part of.

Returns: (None | string)

Bcf.BCFMarkup.getTopicStatus()

getTopicStatus(): (None | string)

Gets the topic status.

Returns: (None | string)

Bcf.BCFMarkup.getTopicTitle()

getTopicTitle(): string

Gets the title of the markup topic.

Returns: string

Bcf.BCFMarkup.getTopicType()

getTopicType(): (None | string)

Gets the topic type.

Returns: (None | string)

Bcf.BCFMarkup.getViewpoints()

getViewpoints(): Map

Gets a map of GUIDs and corresponding viewpoints.

Returns: Map

Bcf.BCFMarkup.setTopicAssignedTo()

setTopicAssignedTo(assignedTo: (None | string)): void

Sets the user that the topic is assigned to.

Parameters

assignedTo: (None | string)

Returns: void

Bcf.BCFMarkup.setTopicCreationAuthor()

setTopicCreationAuthor(author: string): void

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

Parameters

author: string

Returns: void

Bcf.BCFMarkup.setTopicCreationDate()

setTopicCreationDate(date: Date): void

Sets the creation date of the markup topic;

Parameters

date: Date

Returns: void

Bcf.BCFMarkup.setTopicDescription()

setTopicDescription(description: (None | string)): void

Sets the topic description;

Parameters

description: (None | string)

Returns: void

Bcf.BCFMarkup.setTopicDueDate()

setTopicDueDate(date: (None | Date)): void

Sets the topic due date.

Parameters

date: (None | Date)

Returns: void

Bcf.BCFMarkup.setTopicId()

setTopicId(guid: string): void

Sets the topic id.

Parameters

guid: string

Returns: void

Bcf.BCFMarkup.setTopicIndex()

setTopicIndex(index: (None | number)): void

Sets the topic index.

Parameters

index: (None | number)

Returns: void

Bcf.BCFMarkup.setTopicLabels()

setTopicLabels(labels: string[]): void

Sets the topic labels.

Parameters

labels: string[]

Returns: void

Bcf.BCFMarkup.setTopicModifiedAuthor()

setTopicModifiedAuthor(modifiedAuthor: (None | string)): void

Sets the author that last modified the topic.

Parameters

modifiedAuthor: (None | string)

Returns: void

Bcf.BCFMarkup.setTopicModifiedDate()

setTopicModifiedDate(date: (None | Date)): void

Sets the topic modified date.

Parameters

date: (None | Date)

Returns: void

Bcf.BCFMarkup.setTopicPriority()

setTopicPriority(priority: (None | string)): void

Sets the topic priority.

Parameters

priority: (None | string)

Returns: void

Bcf.BCFMarkup.setTopicReferenceLink()

setTopicReferenceLink(referenceLink: (None | string)): void

Sets the ReferenceLink.

Parameters

referenceLink: (None | string)

Returns: void

Bcf.BCFMarkup.setTopicState()

setTopicState(stage: (None | string)): void

Sets the topic stage;

Parameters

stage: (None | string)

Returns: void

Bcf.BCFMarkup.setTopicStatus()

setTopicStatus(topicStatus: (None | string)): void

Sets the topic status.

Parameters

topicStatus: (None | string)

Returns: void

Bcf.BCFMarkup.setTopicTitle()

setTopicTitle(title: string): void

Sets the title of the markup topic.

Parameters

title: string

Returns: void

Bcf.BCFMarkup.setTopicType()

setTopicType(topicType: (None | string)): void

Sets the topic type.

Parameters

topicType: (None | string)

Returns: void

Bcf.BCFMarkup.updateComment()

updateComment(comment: BCFComment): void

Updates a topic comment.

Parameters

comment: BCFComment

Returns: void