editor › Globals › SimpleNester

Class: SimpleNester

Nests polygons by placing them next to each other in a row

Hierarchy

↳ Nester

↳ SimpleNester

Index

Constructors

• constructor

Properties

• cancelToken
• groupRepresentationsMap
• height
• hintEventEmitter
• progressEventEmitter
• warningEventEmitter
• width

Methods

• _onHint
• _onProgress
• _onWarning
• getHeight
• getHintEventEmitter
• getProgressEventEmitter
• getWarningEventEmitter
• getWidth
• nest

Constructors

constructor

+ new SimpleNester(groupRepresentationsMap: Map‹PlateGroup, IPlateGroup2DRepresentations›): SimpleNester

Overrides Nester.constructor

Defined in src/modules/kyub.core.svgObjExporter/src/export/SimpleNester.ts:12

Parameters:

Name	Type
groupRepresentationsMap	Map‹PlateGroup, IPlateGroup2DRepresentations›

Returns: SimpleNester

Properties

Protected Readonly cancelToken

• cancelToken: any

Inherited from Nester.cancelToken

Defined in src/modules/kyub.core.svgObjExporter/src/export/Nester.ts:21

---

Protected groupRepresentationsMap

• groupRepresentationsMap: Map‹PlateGroup, IPlateGroup2DRepresentations›

Inherited from Nester.groupRepresentationsMap

Defined in src/modules/kyub.core.svgObjExporter/src/export/Nester.ts:18

---

Protected height

• height: number

Inherited from Nester.height

Defined in src/modules/kyub.core.svgObjExporter/src/export/Nester.ts:20

---

Protected Readonly hintEventEmitter

• hintEventEmitter: EventEmitter‹object› = new EventEmitter<{ message: string; newExportSettings?; }>()

Inherited from PipelineEventsEmitter.hintEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:20

---

Protected Readonly progressEventEmitter

• progressEventEmitter: EventEmitter‹object› = new EventEmitter<{ stage: string; progress: number; }>()

Inherited from PipelineEventsEmitter.progressEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:12

---

Protected Readonly warningEventEmitter

• warningEventEmitter: EventEmitter‹object› = new EventEmitter<{ code: string; message: string; }>()

Inherited from PipelineEventsEmitter.warningEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:16

---

Protected width

• width: number

Inherited from Nester.width

Defined in src/modules/kyub.core.svgObjExporter/src/export/Nester.ts:19

Methods

Protected _onHint

▸ _onHint(hint: any): void

Inherited from PipelineEventsEmitter._onHint

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:45

Parameters:

Name	Type
hint	any

Returns: void

---

Protected _onProgress

▸ _onProgress(args: object): void

Inherited from PipelineEventsEmitter._onProgress

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:37

Parameters:

▪ args: object

Name	Type
progress	number
stage	string

Returns: void

---

Protected _onWarning

▸ _onWarning(warning: object): void

Inherited from PipelineEventsEmitter._onWarning

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:41

Parameters:

▪ warning: object

Name	Type
code	string
message	string

Returns: void

---

getHeight

▸ getHeight(): number

Inherited from Nester.getHeight

Defined in src/modules/kyub.core.svgObjExporter/src/export/Nester.ts:52

Returns: number

---

getHintEventEmitter

▸ getHintEventEmitter(): IPublicEventEmitterInterface‹object›

Inherited from PipelineEventsEmitter.getHintEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:33

Returns: IPublicEventEmitterInterface‹object›

---

getProgressEventEmitter

▸ getProgressEventEmitter(): IPublicEventEmitterInterface‹object›

Inherited from PipelineEventsEmitter.getProgressEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:25

Returns: IPublicEventEmitterInterface‹object›

---

getWarningEventEmitter

▸ getWarningEventEmitter(): IPublicEventEmitterInterface‹object›

Inherited from PipelineEventsEmitter.getWarningEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:29

Returns: IPublicEventEmitterInterface‹object›

---

getWidth

▸ getWidth(): number

Inherited from Nester.getWidth

Defined in src/modules/kyub.core.svgObjExporter/src/export/Nester.ts:48

Returns: number

---

nest

▸ nest(spacing: number): Promise‹IPage[]›

Overrides Nester.nest

Defined in src/modules/kyub.core.svgObjExporter/src/export/SimpleNester.ts:17

Parameters:

Name	Type	Default
spacing	number	0

Returns: Promise‹IPage[]›