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 objects of DrawingView class.

Extends

Constructors

Constructor

new Sheet(): Sheet

Returns

Sheet

Overrides

BaseObject.constructor

Properties

views

readonly views: Set<View>

Collection of views.

Accessors

height

Get Signature

get height(): number

Returns the height of the sheet.

Returns

number


id

Get Signature

get id(): bigint

Returns object id.

Returns

bigint

Inherited from

BaseObject.id


numberOfViews

Get Signature

get numberOfViews(): number

Returns the number of child views.

Deprecated

Use views.size instead.

Returns

number


orientation

Get Signature

get orientation(): OrientationType

Returns the orientation of the sheet.

Returns

OrientationType


paperSize

Get Signature

get paperSize(): PaperSizeType

Returns the standard paper size of the sheet, if one was defined.

Returns

PaperSizeType


uuid

Get Signature

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

Returns uuid of the drawing sheet. null if the drawing sheet has no assigned uuid (by default).

Returns

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

Set Signature

set uuid(uuid): void

Sets uuid of the drawing sheet.

Parameters

uuid

Uuid of the drawing sheet.

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

Returns

void


width

Get Signature

get width(): number

Returns the width of the sheet.

Returns

number

Methods

addView()

addView(view): void

Adds a view to the sheet.

Parameters

view

View

Added view.

Returns

void

Deprecated

Use views.add(`view`) instead.


setCustomSheetSize()

setCustomSheetSize(width, height): void

Sets the custom sheet size with specified dimensions.

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