Class SetDocLabelColorDto<T>

DTO for setting the color of a label in a document. Takes the document handle directly instead of docId.

Type Parameters

Index

Constructors

constructor

Properties

document label r g b a

Constructors

constructor

new SetDocLabelColorDto<T>(
    document?: T,
    label?: string,
    r?: number,
    g?: number,
    b?: number,
    a?: number,
): SetDocLabelColorDto<T>
Type Parameters
- T
Parameters
- Optionaldocument: T
- Optionallabel: string
- Optionalr: number
- Optionalg: number
- Optionalb: number
- Optionala: number
Returns SetDocLabelColorDto<T>
- Defined in bitbybit-docs.d.ts:8955

Properties

document

document: T

Assembly document handle from buildAssemblyDocument or loadStepToDoc

Default

undefined

label

label: string

Label of the part/instance to color

Default

undefined

r

r: number

Red component (0.0 - 1.0)

Default

0.5

Minimum

Maximum

Step

0.01

g

g: number

Green component (0.0 - 1.0)

Default

0.5

Minimum

Maximum

Step

0.01

b

b: number

Blue component (0.0 - 1.0)

Default

0.5

Minimum

Maximum

Step

0.01

a

a: number

Alpha component (0.0 - 1.0, 1.0 = opaque)

Default

1.0

Minimum

Maximum

Step

0.01

Class SetDocLabelColorDto<T>

Type Parameters

Index

Constructors

Properties

Constructors

constructor

Type Parameters

Parameters

Returns SetDocLabelColorDto<T>

Properties

document

Default

label

Default

r

Default

Minimum

Maximum

Step

g

Default

Minimum

Maximum

Step

b

Default

Minimum

Maximum

Step

a

Default

Minimum

Maximum

Step

Settings

On This Page