Interface ArticleRepresentation

Represents one article

An article is a set of nodes.

The nodes have the following characteristics:

  • All nodes have the same multiplicity
  • All nodes besides the first node have at most one source
  • All nodes besides the last node have at most one target

multiplicity is not meaningful for nodes of WorkStepType sheet and packaging.

Hierarchy

  • ArticleRepresentation

Properties

comment externalDrawingNumber externalPartNumber externalRevisionNumber globalMaterialId multiplicity name scaleData sheetMaterialId vertexKeys

Properties

comment

comment: string

Comment for the article

externalDrawingNumber

externalDrawingNumber: string

User-defined drawing number

Note: By default this value is unused / empty.

externalPartNumber

externalPartNumber: string

User-defined part number

Note: By default this value is unused / empty.

externalRevisionNumber

externalRevisionNumber: string

User-defined revision number

Note: By default this value is unused / empty.

globalMaterialId

globalMaterialId: undefined | string

Material associated with the sheet article (if available)

Legacy field; same as sheetMaterialId

multiplicity

multiplicity: number

Multiplicity of the article (use with caution)

name

name: string

Name of the article

Note: There is no guarantee for this value to be unique.

scaleData

scaleData: ScaleDataEntry[]

Scale data for the article

Scale data is computed for component-articles and joining-articles only.

Scale data is not computed for sheet-articles.

sheetMaterialId

sheetMaterialId: undefined | string

Material associated with the sheet article (if available)

vertexKeys

vertexKeys: string[]

Keys of the nodes the article consists of

Settings

Member Visibility

Theme

Generated using TypeDoc