bitbybit.dev v1.0.0-rc.1
    Preparing search index...

    Class CombineAssemblyStructureDto<T>

    DTO for combining parts and nodes into an assembly structure. Use this as the final step to create a complete structure definition.

    For updating existing documents:

    • Use removals to specify labels to remove
    • Use partUpdates to update existing parts (shape, name, color)

    Type Parameters

    • T
    Index

    Constructors

    Properties

    parts: AssemblyPartDef<T>[]

    List of part definitions (shapes that can be instanced)

    []
    

    List of node definitions (assemblies and instances)

    []
    
    removals?: string[]

    Labels to remove from existing document. Can be part labels, instance labels, or assembly labels. Ignored when creating a new document (no existingDocument provided).

    undefined
    
    partUpdates?: AssemblyPartUpdateDef<T>[]

    Updates to apply to existing parts in the document. Each update can change the shape, name, and/or color of a part. Ignored when creating a new document (no existingDocument provided).

    undefined
    
    clearDocument: boolean

    Whether to clear the existing document before adding new content. Only relevant when an existingDocument is provided to buildAssemblyDocument.

    • true: Clear all existing shapes, then add new parts/nodes (full rebuild)
    • false: Keep existing shapes, apply removals/updates, add new parts/nodes (incremental)
    false