# class Component

---

---

Component inherits from NameId

---

# MEMBERS

# member ^read-only part

Type: Part

# member ^read-only product

Type: Product

# member ^read-only type

Type: Part.Type

# member ^read-only project

Type: Project

# member ^read-only spacing

Type: Spacing

# member ^read-only xScale

Type: Number

# member ^read-only yScale

Type: Number

# member ^read-only rectangular

Type: Boolean

# member ^read-only dieDesign

Type: DieDesign

# member ^read-only shape

Type: ImmutablePath

# member ^read-only offcutShape

Type: ImmutablePath

# member ^read-only pages

Type: List

# member ^read-only doubleSided

Type: Boolean

# member ^read-only offcut

Type: Offcut

# member ^read-only quantity

Type: Number

# member ^read-only placed

Type: Number

# member ^read-only total

Type: Number

# member ^read-only overrun

Type: Number

# member ^read-only fulfilled

Type: Boolean

# member ^read-only layoutsPlaced

Type: List

# member ^read-only spanned

Type: Boolean

# member ^read-only projectIndex

Type: Number

# member ^read-only partIndex

Type: Number

# member ^read-only scalable

Type: Boolean

# member ^read-only props

Type: ImmutableProperties

# FUNCTIONS

# function getDieDesign(side)

Description:

Parameters:

• side: (Side) -

Return:

(DieDesign) -

# function shape(side)

Description:

Parameters:

• side: (Side) -

Return:

(ImmutablePath) -

# function pages(side)

Description:

Parameters:

• side: (Side) -

Return:

(List) -

# function area()

Description:

Return:

(Number) -

# function orderedArea()

Description:

Return:

(Number) -

# function origin(side)

Description:

Parameters:

• side: (Side) -

Return:

(ImmutablePoint) -

# function rotatedPath(path, rotation)

Description:

Parameters:

• path: (ImmutablePath) -
• rotation: (Number) -

Return:

(ImmutablePath) -

# function rotatedPath(path, rotation, side)

Description:

Parameters:

• path: (ImmutablePath) -
• rotation: (Number) -
• side: (Side) -

Return:

(ImmutablePath) -

# function hasSameShape(other)

Description:

Parameters:

• other: (Component) -

Return:

(Boolean) -

# function hasSameSpacing(other)

Description:

Parameters:

• other: (Component) -

Return:

(Boolean) -

# function effectiveSpacingMargin()

Description:

Return:

(ImmutableLength) -

# function hasSameBleedBounds(other)

Description:

Parameters:

• other: (Component) -

Return:

(Boolean) -

# function spacingRect()

Description:

Return:

(ImmutableRect) -

# function spacingPath()

Description:

Return:

(ImmutablePath) -

# function spacingPath(side)

Description:

Parameters:

• side: (Side) -

Return:

(ImmutablePath) -

# function printInks(side)

Description:

Parameters:

• side: (Side) -

Return:

(List) -

# function layouts()

Description:

Return:

(List) -

# function getPlaced(layout)

Description:

Parameters:

• layout: (Layout) -

Return:

(Number) -

# function isLastLayout(layout)

Description:

Parameters:

• layout: (Layout) -

Return:

(Boolean) -

# function instances(surface)

Description:

Parameters:

• surface: (LayoutSurface) -

Return:

(List) -

# function allInstances(side)

Description:

Parameters:

• side: (Side) -

Return:

(List) -

# function image(width, height)

Description:

Parameters:

• width: (Number) -
• height: (Number) -

Return:

(Image) -

# function containsPage(page)

Description:

Parameters:

• page: (Page) -

Return:

(Boolean) -