Interface DwgViewportEntity

interface DwgViewportEntity {
    ambientLightColor?: string;
    backClipZ: number;
    backgroundId?: string;
    brightness: number;
    circleZoomPercent: number;
    clippingBoundaryId?: string;
    color?: number;
    colorIndex?: number;
    colorName?: string;
    contrast: number;
    defaultLightingType?: DwgDefaultLightingType;
    displayCenter: DwgPoint2D;
    elevation: number;
    frontClipZ: number;
    frozenLayerIds?: string[];
    gridSpacing: DwgPoint2D;
    handle: number;
    height: number;
    isDefaultLighting: boolean;
    isInPaperSpace?: boolean;
    isVisible?: boolean;
    layer: string;
    lineType?: string;
    lineTypeScale?: number;
    lineweight?: number;
    majorGridFrequency: number;
    materialObjectHardId?: string;
    orthographicType?: DwgOrthographicType;
    ownerBlockRecordSoftId: number;
    ownerDictionaryHardId?: string | number | boolean;
    ownerDictionarySoftId?: string | number | boolean;
    perspectiveLensLength: number;
    plotStyleHardId?: string;
    proxyByte?: number;
    proxyEntity?: string;
    renderMode: DwgRenderMode;
    shadePlotId?: string;
    shadePlotMode: DwgShadePlotMode;
    shadowMode?: number;
    sheetName: string;
    snapAngle: number;
    snapBase: DwgPoint2D;
    snapSpacing: DwgPoint2D;
    softPointer?: string;
    status: number;
    statusBitFlags: number;
    sunId?: string;
    targetPoint: DwgPoint3D;
    transparency?: number;
    type: "VIEWPORT";
    ucsBaseId?: string;
    ucsId?: string;
    ucsOrigin?: DwgPoint3D;
    ucsPerViewport: DwgUCSPerViewport;
    ucsXAxis?: DwgPoint3D;
    ucsYAxis?: DwgPoint3D;
    viewDirection: DwgPoint3D;
    viewHeight: number;
    viewportCenter: DwgPoint3D;
    viewportId: number;
    viewTwistAngle: number;
    visualStyleId?: string;
    width: number;
    xdata?: DwgXData;
}

Hierarchy (View Summary)

Properties

ambientLightColor? backClipZ backgroundId? brightness circleZoomPercent clippingBoundaryId? color? colorIndex? colorName? contrast defaultLightingType? displayCenter elevation frontClipZ frozenLayerIds? gridSpacing handle height isDefaultLighting isInPaperSpace? isVisible? layer lineType? lineTypeScale? lineweight? majorGridFrequency materialObjectHardId? orthographicType? ownerBlockRecordSoftId ownerDictionaryHardId? ownerDictionarySoftId? perspectiveLensLength plotStyleHardId? proxyByte? proxyEntity? renderMode shadePlotId? shadePlotMode shadowMode? sheetName snapAngle snapBase snapSpacing softPointer? status statusBitFlags sunId? targetPoint transparency? type ucsBaseId? ucsId? ucsOrigin? ucsPerViewport ucsXAxis? ucsYAxis? viewDirection viewHeight viewportCenter viewportId viewTwistAngle visualStyleId? width xdata?

Properties

OptionalambientLightColor

ambientLightColor?: string

backClipZ

backClipZ: number

OptionalbackgroundId

backgroundId?: string

brightness

brightness: number

circleZoomPercent

circleZoomPercent: number

OptionalclippingBoundaryId

clippingBoundaryId?: string

Optionalcolor

color?: number

A 24-bit color value that should be dealt with in terms of bytes with values of 0 to 255. The lowest byte is the blue value, the middle byte is the green value, and the third byte is the red value. The top byte is always 0. The group code cannot be used by custom entities for their own data because the group code is reserved for AcDbEntity, class-level color data and AcDbEntity, class-level transparency data

OptionalcolorIndex

colorIndex?: number

Color number (present if not BYLAYER); zero indicates the BYBLOCK (floating) color; 256 indicates BYLAYER; a negative value indicates that the layer is turned off (optional)

OptionalcolorName

colorName?: string

Color name. The group code cannot be used by custom entities for their own data because the group code is reserved for AcDbEntity, class-level color data and AcDbEntity, class-level transparency data

contrast

contrast: number

OptionaldefaultLightingType

defaultLightingType?: DwgDefaultLightingType

displayCenter

displayCenter: DwgPoint2D

elevation

elevation: number

frontClipZ

frontClipZ: number

OptionalfrozenLayerIds

frozenLayerIds?: string[]

gridSpacing

gridSpacing: DwgPoint2D

handle

handle: number

Handle

height

height: number

isDefaultLighting

isDefaultLighting: boolean

OptionalisInPaperSpace

isInPaperSpace?: boolean

Absent or zero indicates entity is in model space. 1 indicates entity is in paper space (optional).

OptionalisVisible

isVisible?: boolean

Object visibility (optional):

  • 0: Visible
  • 1: Invisible

layer

layer: string

Layer name

OptionallineType

lineType?: string

Linetype name (present if not BYLAYER). The special name BYBLOCK indicates a floating linetype (optional)

OptionallineTypeScale

lineTypeScale?: number

Linetype scale (optional)

Optionallineweight

lineweight?: number

Lineweight enum value. Stored and moved around as a 16-bit integer.

majorGridFrequency

majorGridFrequency: number

OptionalmaterialObjectHardId

materialObjectHardId?: string

Hard-pointer ID/handle to material object (present if not BYLAYER)

OptionalorthographicType

orthographicType?: DwgOrthographicType

ownerBlockRecordSoftId

ownerBlockRecordSoftId: number

Soft-pointer ID/handle to owner BLOCK_RECORD object

OptionalownerDictionaryHardId

ownerDictionaryHardId?: string | number | boolean

Hard-owner ID/handle to owner dictionary (optional)

OptionalownerDictionarySoftId

ownerDictionarySoftId?: string | number | boolean

Soft-pointer ID/handle to owner dictionary (optional)

perspectiveLensLength

perspectiveLensLength: number

OptionalplotStyleHardId

plotStyleHardId?: string

Hard-pointer ID/handle to the plot style object

OptionalproxyByte

proxyByte?: number

Number of bytes in the proxy entity graphics represented in the subsequent 310 groups, which are binary chunk records (optional)

OptionalproxyEntity

proxyEntity?: string

Proxy entity graphics data (multiple lines; 256 characters max. per line) (optional)

renderMode

renderMode: DwgRenderMode

OptionalshadePlotId

shadePlotId?: string

shadePlotMode

shadePlotMode: DwgShadePlotMode

OptionalshadowMode

shadowMode?: number

Shadow mode

  • 0: Casts and receives shadows
  • 1: Casts shadows
  • 2: Receives shadows
  • 3: Ignores shadows

Note: Starting with AutoCAD 2016-based products, this property is obsolete but still supported for backwards compatibility.

sheetName

sheetName: string

snapAngle

snapAngle: number

snapBase

snapBase: DwgPoint2D

snapSpacing

snapSpacing: DwgPoint2D

OptionalsoftPointer

softPointer?: string

status

status: number

statusBitFlags

statusBitFlags: number

OptionalsunId

sunId?: string

targetPoint

targetPoint: DwgPoint3D

Optionaltransparency

transparency?: number

Transparency value. The group code cannot be used by custom entities for their own data because the group code is reserved for AcDbEntity, class-level color data and AcDbEntity, class-level transparency data

type

type: "VIEWPORT"

Entity type

OptionalucsBaseId

ucsBaseId?: string

OptionalucsId

ucsId?: string

OptionalucsOrigin

ucsOrigin?: DwgPoint3D

ucsPerViewport

ucsPerViewport: DwgUCSPerViewport

OptionalucsXAxis

ucsXAxis?: DwgPoint3D

OptionalucsYAxis

ucsYAxis?: DwgPoint3D

viewDirection

viewDirection: DwgPoint3D

viewHeight

viewHeight: number

viewportCenter

viewportCenter: DwgPoint3D

viewportId

viewportId: number

viewTwistAngle

viewTwistAngle: number

OptionalvisualStyleId

visualStyleId?: string

width

width: number

Optionalxdata

xdata?: DwgXData

The extension dictionary attached to the entity (optional).

Settings

Member Visibility

On This Page

Properties