Hide menu
Loading...
Searching...
No Matches
Drawing

Represents a single 2D drawing of a model.

Encapsulates sheets, views, and layers with various 2D geometry. An object of this class is a counterpart to the Model class, meaning that it represents all drawing-related information for a single 3D model. If the model is entirely 2D, an object corresponds to a single input file.

Extends

Constructors

Constructor

new Drawing(sheet?): Drawing

Creates a drawing.

Parameters

sheet?

Sheet

Optional sheet used to initialize the drawing with a single sheet.

Returns

Drawing

Overrides

BaseObject.constructor

Properties

layers

readonly layers: Set<Layer>

Layers contained in the drawing.


sheets

readonly sheets: Set<Sheet>

Sheets contained in the drawing.

Accessors

id

Get Signature

get id(): bigint

Returns the unique identifier of the object.

Returns

bigint

Inherited from

BaseObject.id


numberOfLayers

Get Signature

get numberOfLayers(): number

Returns the number of layers in the drawing.

Deprecated

Use Drawing.layers and layers.size instead.

Returns

number


numberOfSheets

Get Signature

get numberOfSheets(): number

Returns the number of sheets in the drawing.

Deprecated

Use Drawing.sheets and sheets.size instead.

Returns

number

Methods

addLayer()

addLayer(layer): void

Adds a layer to the drawing.

Parameters

layer

Layer

Layer to add.

Returns

void

Deprecated

Use Drawing.layers and layers.add(layer) instead.


addSheet()

addSheet(sheet): void

Adds a sheet to the drawing.

Parameters

sheet

Sheet

Sheet to add.

Returns

void

Deprecated

Use Drawing.sheets and sheets.add(sheet) instead.