This class ised used to pass back information to the user about the viewing characteristics of the current viewport.

Constructors

Accessors

  • get groupId(): string
  • The id of the group which this viewport belongs to.

    Returns string

  • set groupId(value: string): void
  • Parameters

    • value: string

    Returns void

  • get height(): number
  • The height of the viewport entity's window in drawing units.

    Returns number

  • set height(value: number): void
  • Parameters

    • value: number

    Returns void

  • get number(): number
  • The viewport ID number. If the viewport is inactive, -1 is returned.

    Returns number

  • set number(value: number): void
  • Parameters

    • value: number

    Returns void

  • get viewHeight(): number
  • The height (in display coordinate system coordinates) of the Model Space view within the viewport. Zooming the view out within the viewport increases this value and zooming in decreases this value.

    Returns number

  • set viewHeight(value: number): void
  • Parameters

    • value: number

    Returns void

  • get viewWidth(): number
  • The width (in display coordinate system coordinates) of the Model Space view within the viewport. This is one computed property based on 'viewHeight' and viewport ratio of width and height.

    Returns number

  • get width(): number
  • The width of the viewport entity's window in drawing units. This is the width in Paper Space of the viewport itself, not the width of the Model Space view within the viewport.

    Returns number

  • set width(value: number): void
  • Parameters

    • value: number

    Returns void

Methods