Interface DwgDimensionEntityCommon

interface DwgDimensionEntityCommon {
    attachmentPoint: DwgAttachmentPoint;
    color?: number;
    colorIndex?: number;
    colorName?: string;
    definitionPoint: DwgPoint3D;
    dimensionType: DwgDimensionType;
    extrusionDirection?: DwgPoint3D;
    handle: number;
    isInPaperSpace?: boolean;
    isVisible?: boolean;
    layer: string;
    lineType?: string;
    lineTypeScale?: number;
    lineweight?: number;
    materialObjectHardId?: string;
    measurement?: number;
    name: string;
    ocsRotation?: number;
    ownerBlockRecordSoftId: number;
    ownerDictionaryHardId?: string | number | boolean;
    ownerDictionarySoftId?: string | number | boolean;
    plotStyleHardId?: string;
    proxyByte?: number;
    proxyEntity?: string;
    shadowMode?: number;
    styleName: string;
    subclassMarker: string;
    text?: string;
    textLineSpacingFactor?: number;
    textLineSpacingStyle?: DwgDimensionTextLineSpacing;
    textPoint: DwgPoint2D;
    textRotation?: number;
    transparency?: number;
    type: "DIMENSION";
    version: number;
    xdata?: DwgXData;
}

Hierarchy (View Summary)

Properties

attachmentPoint color? colorIndex? colorName? definitionPoint dimensionType extrusionDirection? handle isInPaperSpace? isVisible? layer lineType? lineTypeScale? lineweight? materialObjectHardId? measurement? name ocsRotation? ownerBlockRecordSoftId ownerDictionaryHardId? ownerDictionarySoftId? plotStyleHardId? proxyByte? proxyEntity? shadowMode? styleName subclassMarker text? textLineSpacingFactor? textLineSpacingStyle? textPoint textRotation? transparency? type version xdata?

Properties

attachmentPoint

attachmentPoint: DwgAttachmentPoint

Attachment point:

  • 1: Top left
  • 2: Top center
  • 3: Top right
  • 4: Middle left
  • 5: Middle center
  • 6: Middle right
  • 7: Bottom left
  • 8: Bottom center
  • 9: Bottom right

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

definitionPoint

definitionPoint: DwgPoint3D

Definition point (in WCS)

dimensionType

dimensionType: DwgDimensionType

Dimension type: Values 0-6 are integer values that represent the dimension type. Values 32, 64, and 128 are bit values, which are added to the integer values (value 32 is always set in R13 and later releases)

  • 0: Rotated, horizontal, or vertical
  • 1: Aligned
  • 2: Angular
  • 3: Diameter
  • 4: Radius
  • 5: Angular 3-point
  • 6: Ordinate
  • 32: Indicates that the block reference (group code 2) is referenced by this dimension only
  • 64: Ordinate type. This is a bit value (bit 7) used only with integer value 6. If set, ordinate is X-type; if not set, ordinate is Y-type.
  • 128: This is a bit value (bit 8) added to the other group 70 values if the dimension text has been positioned at a user-defined location rather than at the default location.

OptionalextrusionDirection

extrusionDirection?: DwgPoint3D

Extrusion direction (optional; default = 0, 0, 1)

handle

handle: number

Handle

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.

OptionalmaterialObjectHardId

materialObjectHardId?: string

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

Optionalmeasurement

measurement?: number

Actual measurement (optional; read-only value)

name

name: string

Name of the block that contains the entities that make up the dimension picture

OptionalocsRotation

ocsRotation?: number

The horizontal direction for the dimension entity. The dimension entity determines the orientation of dimension text and lines for horizontal, vertical, and rotated linear dimensions This group value is the negative of the angle between the OCS X axis and the UCS X axis. It is always in the XY plane of the OCS.

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)

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)

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.

styleName

styleName: string

Dimension style name

subclassMarker

subclassMarker: string

Optionaltext

text?: string

Dimension text explicitly entered by the user. Optional; default is the measurement. If null or “<>”, the dimension measurement is drawn as the text, if ““ (one blank space), the text is suppressed. Anything else is drawn as the text

OptionaltextLineSpacingFactor

textLineSpacingFactor?: number

Dimension text-line spacing factor (optional): Percentage of default (3-on-5) line spacing to be applied. Valid values range from 0.25 to 4.00

OptionaltextLineSpacingStyle

textLineSpacingStyle?: DwgDimensionTextLineSpacing

Dimension text line-spacing style (optional):

  • 1 (or missing): At least (taller characters will override)
  • 2: Exact (taller characters will not override)

textPoint

textPoint: DwgPoint2D

Middle point of dimension text (in OCS)

OptionaltextRotation

textRotation?: number

The rotation angle of the dimension text away from its default orientation (the direction of the dimension line) (optional)

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: "DIMENSION"

Entity type

version

version: number

Version number:

  • 0: 2010

Optionalxdata

xdata?: DwgXData

The extension dictionary attached to the entity (optional).

Settings

Member Visibility

On This Page

Properties