CIP JavaScript documentation for class " pfcSymbolDefAttachment"

Class pfcSymbolDefAttachment

Description

This interface represents the way that an instance may be attached to a symbol definition.

Property Summary


`/* optional */ number`	`AttachmentParam`
	The parameter on the entity (typically a t parameter). `null`, if the attachment type is SYMDEFATTACH_FREE or SYMDEFATTACH_RADIAL_LEADER.

`pfcPoint3D`	`AttachmentPoint`
	The attachment point, in the coordinate system of the symbol definition.

`/* optional */ number`	`EntityId`
	The identifier of the symbol definition entity. `null`, if the attachment type is SYMDEFATTACH_FREE.

`pfcSymbolDefAttachmentType`	`Type`
	The type of attachment.

Method Summary


`static pfcSymbolDefAttachment`	`Create (pfcSymbolDefAttachmentType inType, pfcPoint3D inAttachmentPoint)`
	Creates a data object that represents the way that an instance may be attached to a symbol definition.

Property Detail

/* optional */ number AttachmentParam

The parameter on the entity (typically a t parameter). null, if the attachment type is SYMDEFATTACH_FREE or SYMDEFATTACH_RADIAL_LEADER.

pfcPoint3D AttachmentPoint

The attachment point, in the coordinate system of the symbol definition.

/* optional */ number EntityId

The identifier of the symbol definition entity. null, if the attachment type is SYMDEFATTACH_FREE.

pfcSymbolDefAttachmentType Type

The type of attachment.

Method Detail

static pfcSymbolDefAttachment Create (pfcSymbolDefAttachmentType inType, pfcPoint3D inAttachmentPoint)

Creates a data object that represents the way that an instance may be attached to a symbol definition.

Parameters:

inType: The type of attachment.
inAttachmentPoint: The attachment point, in the coordinate system of the symbol definition.