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

Constructors

Accessors

  • get annotationScaleFactor(): number
  • Annotation scale factor (drawingUnits / paperUnits) for this viewport. 0 when unset.

    Returns number

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

    • value: number

    Returns void

  • get annotationScaleName(): string
  • Annotation scale name for this viewport (from ASDK_XREC_ANNOTATION_SCALE_INFO), e.g. "1:50". Empty when unset.

    Returns string

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

    • value: string

    Returns void

  • get frozenLayerIds(): string[]
  • Soft-pointer object ids of layers frozen in this viewport (DXF group 331 / VPLAYER). Empty when the viewport does not freeze any layers.

    Returns string[]

  • set frozenLayerIds(value: string[]): void
  • Parameters

    • value: string[]

    Returns void

  • get frozenLayers(): string[]
  • Names of layers frozen in this viewport (resolved from frozenLayerIds). Used by renderers to hide model-space layer groups while drawing through the viewport.

    Returns string[]

  • set frozenLayers(value: string[]): void
  • Parameters

    • value: string[]

    Returns void

  • 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 viewBox(): AcGeBox2d
  • The bounding box of the Model Space view shown through this viewport, expressed in WCS coordinates.

    viewCenter is stored in DCS; AutoCAD maps it to WCS by rotating by viewTwistAngle and translating by viewTarget (same rule as AcDbViewportTableRecord.modelViewBox for the *ACTIVE VPORT).

    Returns AcGeBox2d

  • 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 viewTwistAngle(): number
  • The view twist angle in radians (DXF group 51).

    Returns number

  • set viewTwistAngle(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