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

    Class CreatePartUpdateDto<T>

    DTO for creating a part update definition. Part updates specify changes to apply to existing parts in a document.

    Type Parameters

    • T
    Index

    Constructors

    constructor

    Properties

    label shape? name? colorRgba?

    Constructors

    • Type Parameters

      • T

      Parameters

      • Optionallabel: string
      • Optionalshape: T
      • Optionalname: string
      • OptionalcolorRgba: ColorRGBA

      Returns CreatePartUpdateDto<T>

    Properties

    label: string

    Label of the existing part to update (e.g., "0:1:1:1"). Obtain this from document queries like getDocumentParts.

    undefined
    shape?: T

    New shape to replace the existing shape. If undefined, the shape is not changed.

    undefined
    name?: string

    New name for the part. If undefined, the name is not changed.

    undefined
    colorRgba?: ColorRGBA

    New color for the part. If undefined, the color is not changed.

    undefined

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties