Hide menu
Loading...
Searching...
No Matches
Sheet

Represents a single sheet of a model drawing.

An object of this class mimics a physical sheet of paper, hence the size and orientation settings.

Normally a drawing sheet would have associated metadata, such as default scale, title block, etc. This information is represented with View objects.

Extends

Constructors

Constructor

new Sheet(): Sheet

Creates a sheet.

The sheet is initialized with A3 paper size and landscape orientation.

Returns

Sheet

Overrides

BaseObject.constructor

Properties

views

readonly views: Set<View>

Views placed on the sheet.

Accessors

height

Get Signature

get height(): number

Height of the sheet.

For standard sheet sizes, width and height depend on the orientation. Changing the orientation swaps width and height.

Returns

number


id

Get Signature

get id(): bigint

Returns the unique identifier of the object.

Returns

bigint

Inherited from

BaseObject.id


numberOfViews

Get Signature

get numberOfViews(): number

Returns the number of views in the sheet.

Deprecated

Use Sheet.views and views.size instead.

Returns

number


orientation

Get Signature

get orientation(): OrientationType

Orientation of the sheet.

Returns

OrientationType


paperSize

Get Signature

get paperSize(): PaperSizeType

Standard paper size of the sheet, if one is defined.

Returns

PaperSizeType


uuid

Get Signature

get uuid(): `${string}-${string}-${string}-${string}-${string}` | null

UUID of the drawing sheet.

The value is null if the drawing sheet has no assigned UUID.

Returns

`${string}-${string}-${string}-${string}-${string}` | null

Set Signature

set uuid(uuid): void

Sets the UUID of the drawing sheet.

Parameters

uuid

`${string}-${string}-${string}-${string}-${string}` | null

UUID of the drawing sheet.

Returns

void


width

Get Signature

get width(): number

Width of the sheet.

For standard sheet sizes, width and height depend on the orientation. Changing the orientation swaps width and height.

Returns

number

Methods

addView()

addView(view): void

Adds a view to the sheet.

Parameters

view

View

View to add.

Returns

void

Deprecated

Use Sheet.views and views.add(view) instead.


setCustomSheetSize()

setCustomSheetSize(width, height): void

Sets the custom sheet size with specified dimensions.

The sheet is marked as user-defined and its orientation is set to landscape.

Parameters

width

number

Width of the sheet.

height

number

Height of the sheet.

Returns

void


setStandardSheetSize()

setStandardSheetSize(paperSize, orientation): void

Sets the sheet size to one of the standard sizes.

Parameters

paperSize

PaperSizeType

Paper size of the sheet.

orientation

OrientationType

Orientation of the sheet.

Returns

void