editor › Globals › SubassemblyBookletStep

Class: SubassemblyBookletStep

This is a composite-node of the booklet step graph: a set of steps that are all performed to build a Subassembly.

Hierarchy

• BookletStep

↳ SubassemblyBookletStep

Index

Constructors

• constructor

Properties

• _isOnlyObject
• friendTexts
• id
• instructions
• objectId
• screenshot
• subassemblyInstruction
• svgPages

Methods

• _addFriendText
• _addPageNumber
• _generateHeaderText
• _getSubassemblyInstruction
• _isPart
• addStep
• addToPdf
• getId
• getScreenshot
• getShortName
• getStepName
• isStartPointForFriend
• renderSVGs
• setOnlyObject

Constructors

constructor

+ new SubassemblyBookletStep(subassemblyInstruction: InstructionStep, id: number, objectId: number): SubassemblyBookletStep

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:34

Creates a SubassemblyBookletStep

Parameters:

Name	Type	Description
subassemblyInstruction	InstructionStep	the instruction this step represents
id	number	the id of this part within the object
objectId	number	the id of the object that this part belongs to

Returns: SubassemblyBookletStep

Properties

Private _isOnlyObject

• _isOnlyObject: boolean

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:27

---

Private Readonly friendTexts

• friendTexts: Array‹object› = [ { header: "Brought a friend?", text: "Let your friend start here!" }, { header: "Brought two or more friends?", text: "Let your second friend start here!" }, { header: "Brought three or more friends?", text: "Let the third friend start here!" }, { header: "Brought even more friends?", text: "Another friend can start here!" }, ]

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:29

---

Private Readonly id

• id: number

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:24

---

instructions

• instructions: InstructionBookletStep[]

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:22

---

Private Readonly objectId

• objectId: string

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:26

---

Private Readonly screenshot

• screenshot: ScreenshotBookletStep

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:23

---

subassemblyInstruction

• subassemblyInstruction: InstructionStep

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:21

---

Private svgPages

• svgPages: Array‹object›

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:25

Methods

Private _addFriendText

▸ _addFriendText(doc: jsPDF): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:187

Parameters:

Name	Type
doc	jsPDF

Returns: void

---

Private _addPageNumber

▸ _addPageNumber(doc: jsPDF, pageNumber: number): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:181

Parameters:

Name	Type
doc	jsPDF
pageNumber	number

Returns: void

---

Private _generateHeaderText

▸ _generateHeaderText(prerequisites: SubassemblyInstruction[]): string

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:162

Parameters:

Name	Type
prerequisites	SubassemblyInstruction[]

Returns: string

---

Private _getSubassemblyInstruction

▸ _getSubassemblyInstruction(): SubassemblyInstruction‹›

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:177

Returns: SubassemblyInstruction‹›

---

Private _isPart

▸ _isPart(): boolean

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:158

Returns: boolean

---

addStep

▸ addStep(step: InstructionBookletStep): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:150

Parameters:

Name	Type
step	InstructionBookletStep

Returns: void

---

addToPdf

▸ addToPdf(doc: jsPDF, xOffset: number, yOffset: number, pageNumber: number): Promise‹number›

Overrides BookletStep.addToPdf

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:56

Parameters:

Name	Type
doc	jsPDF
xOffset	number
yOffset	number
pageNumber	number

Returns: Promise‹number›

---

getId

▸ getId(): number

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:127

Returns: number

---

getScreenshot

▸ getScreenshot(): ScreenshotBookletStep‹›

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:154

Returns: ScreenshotBookletStep‹›

---

getShortName

▸ getShortName(): string

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:118

Returns: string

---

getStepName

▸ getStepName(): string

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:122

Returns: string

---

isStartPointForFriend

▸ isStartPointForFriend(): boolean

Overrides BookletStep.isStartPointForFriend

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:142

Returns: boolean

---

renderSVGs

▸ renderSVGs(highlightableSvg: BookletSvgStylizer): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:131

Parameters:

Name	Type
highlightableSvg	BookletSvgStylizer

Returns: void

---

setOnlyObject

▸ setOnlyObject(): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/SubassemblyBookletStep.ts:52

Returns: void