IFClite TypeScript API
    Preparing search index...

    Interface BCFTopic

    @ifc-lite/bcf - BIM Collaboration Format support

    This package provides BCF (BIM Collaboration Format) support for IFC-Lite. It implements BCF 2.1 and 3.0 specifications for topic tracking in BIM projects.

    interface BCFTopic {
        assignedTo?: string;
        bimSnippet?: BCFBimSnippet;
        comments: BCFComment[];
        creationAuthor?: string;
        creationDate?: string;
        description?: string;
        documentReferences?: BCFDocumentReference[];
        dueDate?: string;
        guid: string;
        header?: BCFHeaderFile[];
        index?: number;
        labels?: string[];
        modifiedAuthor?: string;
        modifiedDate?: string;
        priority?: string;
        relatedTopics?: string[];
        stage?: string;
        title: string;
        topicStatus?: string;
        topicType?: string;
        viewpoints: BCFViewpoint[];
    }
    Index
    assignedTo? bimSnippet? comments creationAuthor? creationDate? description? documentReferences? dueDate? guid header? index? labels? modifiedAuthor? modifiedDate? priority? relatedTopics? stage? title topicStatus? topicType? viewpoints
    assignedTo?: string

    Assigned user email

    bimSnippet?: BCFBimSnippet

    Referenced BIM snippet

    comments: BCFComment[]

    Comments on the topic

    creationAuthor?: string

    Author email. markup.xsd declares CreationAuthor required with no default, but it comes through undefined when the source markup.bcf omits it — see creationDate for why the reader never fabricates a placeholder value ("Unknown") in its place.

    creationDate?: string

    Creation date (ISO 8601). markup.xsd declares this required with no default, but it comes through undefined when the source markup.bcf omits it — the reader never fabricates a read-time wall-clock timestamp in its place (that value would be indistinguishable from a genuinely-declared one, and isn't even stable across repeated reads of the same untouched file).

    description?: string

    Detailed description

    documentReferences?: BCFDocumentReference[]

    Document references

    dueDate?: string

    Due date (ISO 8601)

    guid: string

    Unique identifier (22-char GUID)

    header?: BCFHeaderFile[]

    Source IFC file(s) this topic refers to (markup <Header>). One entry per distinct model touched by the topic, so a federated topic round-trips the provenance of every model it spans. Optional: absent for topics with no resolvable source model.

    index?: number

    Index for ordering topics

    labels?: string[]

    Labels for categorization

    modifiedAuthor?: string

    Modifier email

    modifiedDate?: string

    Modification date (ISO 8601)

    priority?: string

    Priority (e.g., 'High', 'Medium', 'Low')

    relatedTopics?: string[]

    Related topics

    stage?: string

    Stage/phase

    title: string

    Topic title (required)

    topicStatus?: string

    Status (e.g., 'Open', 'In Progress', 'Closed', 'Resolved')

    topicType?: string

    Topic type (e.g., 'Error', 'Warning', 'Info', 'Request')

    viewpoints: BCFViewpoint[]

    Viewpoints associated with the topic

    Settings
    Member Visibility

    On This Page
    Properties