editor › Globals › InstructionBookletStep
Class: InstructionBookletStep
This is a leaf-node of the booklet step graph: a single instruction of adding one or sometimes multiple new plates to the assembly.
Hierarchy
↳ InstructionBookletStep
Index
Constructors
Properties
Methods
Constructors
constructor
+ new InstructionBookletStep(instruction: InstructionStep): InstructionBookletStep
Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/InstructionBookletStep.ts:13
Parameters:
| Name | Type |
|---|---|
instruction |
InstructionStep |
Returns: InstructionBookletStep
Properties
instruction
• instruction: InstructionStep
Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/InstructionBookletStep.ts:11
Private Readonly name
• name: string
Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/InstructionBookletStep.ts:13
Private Readonly screenshot
• screenshot: ScreenshotBookletStep
Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/InstructionBookletStep.ts:12
Methods
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/InstructionBookletStep.ts:28
Parameters:
| Name | Type |
|---|---|
doc |
jsPDF |
xOffset |
number |
yOffset |
number |
pageNumber |
number |
Returns: Promise‹number›
getScreenshot
▸ getScreenshot(): ScreenshotBookletStep‹›
Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/InstructionBookletStep.ts:33
Returns: ScreenshotBookletStep‹›
isStartPointForFriend
▸ isStartPointForFriend(): boolean
Inherited from BookletStep.isStartPointForFriend
Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/BookletStep.ts:9
Returns: boolean