editor › Globals › BookletSvgStylizer
Class: BookletSvgStylizer
Manages the SVGs that are rendered into the booklet. Enables highlighting of certain plates and determines the svg style.
Hierarchy
↳ BookletSvgStylizer
Index
Constructors
Properties
- pageMaterialMap
- pageSizeChangedMap
- pageSizeMap
- plateCutlines
- plateCutouts
- plateIdMap
- plateImageEngravings
- plateJointIdMap
- platePageMap
- plateSVGEngravings
- plateSvgMap
- CutlineClass
- CutlineStyle
- CutoutClass
- EngravingImageClass
- EngravingSVGClass
- EngravingStyle
- FoamCoreCreaseClass
- FoamCoreCreaseStyle
- FoamCoreFoamCutClass
- FoamCoreFoamCutStyle
- GroupIDClass
- HighlightStyle
- HighlightedPlateClass
- InvisibleClass
- InvisibleStyle
- JointIDClass
- NonHighlightStyle
- PlateClass
- RemovedClass
- RemovedStyle
- TextStyle
Methods
- _addPageBackground
- _createImageNodeFromArrayBuffer
- _createText
- _setCutlineStyle
- _setEngravingStyle
- _setFoamCoreFoamCreaseStyle
- _setFoamCoreFoamCutStyle
- _setIdStyle
- _setJointIdStyle
- _setPlateStyle
- _setupStyles
- addAdditionalCut
- addCutline
- addCutout
- addFoamCoreCrease
- addFoamCoreFoamCut
- addFoamCutline
- addImageEngraving
- addPlate
- addSVGEngraving
- addSingleCutline
- annotateGroupId
- createGroupID
- createJointID
- createSymbolicLink
- forceIds
- getSvgPages
- givingLinkSize
- hasTabs
- hideJointIds
- hidePlateContents
- hidePlateText
- highlight
- idFontSize
- jointIdFontSize
- preProcessImage
- receivingLinkSize
- registerPlate
- removePlates
- renderAllPlates
- rendersHoles
- reset
- restyleSvgString
- setPageSize
- setupPage
Constructors
constructor
+ new BookletSvgStylizer(): BookletSvgStylizer
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:30
Returns: BookletSvgStylizer
Properties
Protected Readonly pageMaterialMap
• pageMaterialMap: Map‹SvgBuilder‹›, IPlateMaterial› = new Map
Inherited from AbstractSvgStylizer.pageMaterialMap
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:45
Protected Readonly pageSizeChangedMap
• pageSizeChangedMap: Map‹SvgBuilder‹›, boolean› = new Map
Inherited from AbstractSvgStylizer.pageSizeChangedMap
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:44
Protected Readonly pageSizeMap
• pageSizeMap: Map‹SvgBuilder, IDimensions2› = new Map
Inherited from AbstractSvgStylizer.pageSizeMap
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:43
Protected Readonly plateCutlines
• plateCutlines: Map‹Plate‹›, XMLElement‹›[]› = new Map
Inherited from AbstractSvgStylizer.plateCutlines
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:42
Protected Readonly plateCutouts
• plateCutouts: Map‹Plate‹›, XMLElement‹›[]› = new Map
Inherited from AbstractSvgStylizer.plateCutouts
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:40
Protected Readonly plateIdMap
• plateIdMap: Map‹Plate‹›, XMLElement‹›› = new Map
Inherited from AbstractSvgStylizer.plateIdMap
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:37
Protected Readonly plateImageEngravings
• plateImageEngravings: Map‹Plate‹›, XMLElement‹›[]› = new Map
Inherited from AbstractSvgStylizer.plateImageEngravings
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:41
Protected Readonly plateJointIdMap
• plateJointIdMap: Map‹Plate‹›, XMLElement‹›[]› = new Map
Inherited from AbstractSvgStylizer.plateJointIdMap
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:38
Protected Readonly platePageMap
• platePageMap: Map‹Plate‹›, SvgBuilder‹›› = new Map
Inherited from AbstractSvgStylizer.platePageMap
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:35
Protected Readonly plateSVGEngravings
• plateSVGEngravings: Map‹Plate‹›, XMLElement‹›[]› = new Map
Inherited from AbstractSvgStylizer.plateSVGEngravings
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:39
Protected Readonly plateSvgMap
• plateSvgMap: Map‹Plate‹›, XMLElement‹›› = new Map
Inherited from AbstractSvgStylizer.plateSvgMap
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:36
Static Protected Readonly CutlineClass
▪ CutlineClass: "cutline" = "cutline"
Inherited from AbstractSvgStylizer.CutlineClass
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:25
Static Private Readonly CutlineStyle
▪ CutlineStyle: "stroke:black; opacity:0.7; stroke-width:0.4; fill:none" = "stroke:black; opacity:0.7; stroke-width:0.4; fill:none"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:26
Static Protected Readonly CutoutClass
▪ CutoutClass: "cutout" = "cutout"
Inherited from AbstractSvgStylizer.CutoutClass
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:26
Static Protected Readonly EngravingImageClass
▪ EngravingImageClass: "engravingIMG" = "engravingIMG"
Inherited from AbstractSvgStylizer.EngravingImageClass
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:28
Static Protected Readonly EngravingSVGClass
▪ EngravingSVGClass: "engravingSVG" = "engravingSVG"
Inherited from AbstractSvgStylizer.EngravingSVGClass
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:27
Static Private Readonly EngravingStyle
▪ EngravingStyle: "stroke:none; fill:#4A1716; fill-opacity:0.6" = "stroke:none; fill:#4A1716; fill-opacity:0.6"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:27
Static Protected Readonly FoamCoreCreaseClass
▪ FoamCoreCreaseClass: "foamCoreCrease" = "foamCoreCrease"
Inherited from AbstractSvgStylizer.FoamCoreCreaseClass
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:32
Static Private Readonly FoamCoreCreaseStyle
▪ FoamCoreCreaseStyle: "stroke:black; opacity:0.7; stroke-width:0.4; fill:none" = "stroke:black; opacity:0.7; stroke-width:0.4; fill:none"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:30
Static Protected Readonly FoamCoreFoamCutClass
▪ FoamCoreFoamCutClass: "foamCoreFoamCut" = "foamCoreFoamCut"
Inherited from AbstractSvgStylizer.FoamCoreFoamCutClass
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:31
Static Private Readonly FoamCoreFoamCutStyle
▪ FoamCoreFoamCutStyle: "stroke:black; opacity:0.7; stroke-width:0.4; fill:none" = "stroke:black; opacity:0.7; stroke-width:0.4; fill:none"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:29
Static Protected Readonly GroupIDClass
▪ GroupIDClass: "groupId" = "groupId"
Inherited from AbstractSvgStylizer.GroupIDClass
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:29
Static Private Readonly HighlightStyle
▪ HighlightStyle: "stroke:black; stroke-width:0.8; fill:#88dd88; fill-opacity:0.7" = "stroke:black; stroke-width:0.8; fill:#88dd88; fill-opacity:0.7"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:22
Static Private Readonly HighlightedPlateClass
▪ HighlightedPlateClass: "highlightedPlate" = "highlightedPlate"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:19
Static Private Readonly InvisibleClass
▪ InvisibleClass: "invisible" = "invisible"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:18
Static Private Readonly InvisibleStyle
▪ InvisibleStyle: "visibility:hidden" = "visibility:hidden"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:28
Static Protected Readonly JointIDClass
▪ JointIDClass: "jointId" = "jointId"
Inherited from AbstractSvgStylizer.JointIDClass
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:30
Static Private Readonly NonHighlightStyle
▪ NonHighlightStyle: "stroke:black; stroke-width:0.6; fill:black; fill-opacity:0" = "stroke:black; stroke-width:0.6; fill:black; fill-opacity:0"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:24
Static Protected Readonly PlateClass
▪ PlateClass: "plate" = "plate"
Inherited from AbstractSvgStylizer.PlateClass
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:24
Static Private Readonly RemovedClass
▪ RemovedClass: "removedPlate" = "removedPlate"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:20
Static Private Readonly RemovedStyle
▪ RemovedStyle: "stroke:black; stroke-width:0.8; fill:#ffffff; fill-opacity:1" = "stroke:black; stroke-width:0.8; fill:#ffffff; fill-opacity:1"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:23
Static Private Readonly TextStyle
▪ TextStyle: "fill:black; font-family: sans-serif" = "fill:black; font-family: sans-serif"
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:25
Methods
Protected _addPageBackground
▸ _addPageBackground(svgBuilder: SvgBuilder, pageSize: IDimensions2, material: IMaterial): Promise‹void›
Overrides AbstractSvgStylizer._addPageBackground
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:188
Adds the background to a page.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
svgBuilder |
SvgBuilder | - | The page |
pageSize |
IDimensions2 | - | the size of the plate |
material |
IMaterial | { type: "poplar" } | the type of material |
Returns: Promise‹void›
Protected _createImageNodeFromArrayBuffer
▸ _createImageNodeFromArrayBuffer(svgBuilder: SvgBuilder, parent: IXmlElement, arrayBuffer: ArrayBuffer, size: Vector2, format: string): XMLElement
Inherited from AbstractSvgStylizer._createImageNodeFromArrayBuffer
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:294
Parameters:
| Name | Type | Default |
|---|---|---|
svgBuilder |
SvgBuilder | - |
parent |
IXmlElement | - |
arrayBuffer |
ArrayBuffer | - |
size |
Vector2 | - |
format |
string | "jpg" |
Returns: XMLElement
Protected _createText
▸ _createText(page: any, parent: any, fullText: string, fontsize: number, centerText: boolean): XMLElement
Overrides AbstractSvgStylizer._createText
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:217
Parameters:
| Name | Type | Default |
|---|---|---|
page |
any | - |
parent |
any | - |
fullText |
string | - |
fontsize |
number | - |
centerText |
boolean | false |
Returns: XMLElement
Protected _setCutlineStyle
▸ _setCutlineStyle(page: SvgBuilder): void
Overrides AbstractSvgStylizer._setCutlineStyle
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:230
Parameters:
| Name | Type |
|---|---|
page |
SvgBuilder |
Returns: void
Protected _setEngravingStyle
▸ _setEngravingStyle(page: SvgBuilder): void
Overrides AbstractSvgStylizer._setEngravingStyle
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:225
Parameters:
| Name | Type |
|---|---|
page |
SvgBuilder |
Returns: void
Protected _setFoamCoreFoamCreaseStyle
▸ _setFoamCoreFoamCreaseStyle(page: SvgBuilder): void
Overrides AbstractSvgStylizer._setFoamCoreFoamCreaseStyle
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:246
Parameters:
| Name | Type |
|---|---|
page |
SvgBuilder |
Returns: void
Protected _setFoamCoreFoamCutStyle
▸ _setFoamCoreFoamCutStyle(page: SvgBuilder): void
Overrides AbstractSvgStylizer._setFoamCoreFoamCutStyle
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:242
Parameters:
| Name | Type |
|---|---|
page |
SvgBuilder |
Returns: void
Protected _setIdStyle
▸ _setIdStyle(page: SvgBuilder): void
Overrides AbstractSvgStylizer._setIdStyle
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:234
Parameters:
| Name | Type |
|---|---|
page |
SvgBuilder |
Returns: void
Protected _setJointIdStyle
▸ _setJointIdStyle(page: any): void
Overrides AbstractSvgStylizer._setJointIdStyle
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:238
Parameters:
| Name | Type |
|---|---|
page |
any |
Returns: void
Protected _setPlateStyle
▸ _setPlateStyle(page: SvgBuilder): void
Overrides AbstractSvgStylizer._setPlateStyle
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:221
Parameters:
| Name | Type |
|---|---|
page |
SvgBuilder |
Returns: void
Protected _setupStyles
▸ _setupStyles(page: SvgBuilder): void
Overrides AbstractSvgStylizer._setupStyles
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:175
Parameters:
| Name | Type |
|---|---|
page |
SvgBuilder |
Returns: void
addAdditionalCut
▸ addAdditionalCut(outline: XMLElement, page: SvgBuilder): void
Inherited from AbstractSvgStylizer.addAdditionalCut
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:165
Adds an path as cutline.
Parameters:
| Name | Type | Description |
|---|---|---|
outline |
XMLElement | The XMLElement path. |
page |
SvgBuilder | The page where this outline should be placed |
Returns: void
addCutline
▸ addCutline(plate: Plate, cutline: XMLElement): void
Inherited from AbstractSvgStylizer.addCutline
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:109
Parameters:
| Name | Type |
|---|---|
plate |
Plate |
cutline |
XMLElement |
Returns: void
addCutout
▸ addCutout(plate: Plate, engraving: XMLElement): void
Inherited from AbstractSvgStylizer.addCutout
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:152
Parameters:
| Name | Type |
|---|---|
plate |
Plate |
engraving |
XMLElement |
Returns: void
addFoamCoreCrease
▸ addFoamCoreCrease(creaseLine: XMLElement, page: SvgBuilder): void
Inherited from AbstractSvgStylizer.addFoamCoreCrease
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:185
Adds the passed line as crease.
Parameters:
| Name | Type | Description |
|---|---|---|
creaseLine |
XMLElement | The svg line representing the crease. |
page |
SvgBuilder | The page where this crease should be placed |
Returns: void
addFoamCoreFoamCut
▸ addFoamCoreFoamCut(plate: Plate, outline: XMLElement): void
Inherited from AbstractSvgStylizer.addFoamCoreFoamCut
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:175
Adds the passed plate as foam cut.
Parameters:
| Name | Type | Description |
|---|---|---|
plate |
Plate | The plate object |
outline |
XMLElement | The XMLElement representation of the outline border path. |
Returns: void
addFoamCutline
▸ addFoamCutline(plate: Plate, cutline: XMLElement): void
Inherited from AbstractSvgStylizer.addFoamCutline
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:123
Adds a cutline (as part of a bending) that should be cut through the foam only.
Parameters:
| Name | Type | Description |
|---|---|---|
plate |
Plate | the plate the cutline belongs to |
cutline |
XMLElement | the cutline element to add |
Returns: void
addImageEngraving
▸ addImageEngraving(plate: Plate, engraving: XMLElement): void
Inherited from AbstractSvgStylizer.addImageEngraving
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:132
Parameters:
| Name | Type |
|---|---|
plate |
Plate |
engraving |
XMLElement |
Returns: void
addPlate
▸ addPlate(plate: Plate, path: XMLElement): void
Inherited from AbstractSvgStylizer.addPlate
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:103
Adds a plate with its SVG node
Parameters:
| Name | Type | Description |
|---|---|---|
plate |
Plate | The Plate object |
path |
XMLElement | The node that renders this plate |
Returns: void
addSVGEngraving
▸ addSVGEngraving(plate: Plate, engraving: XMLElement, isCutout: boolean): void
Inherited from AbstractSvgStylizer.addSVGEngraving
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:140
Parameters:
| Name | Type |
|---|---|
plate |
Plate |
engraving |
XMLElement |
isCutout |
boolean |
Returns: void
addSingleCutline
▸ addSingleCutline(frameLine: XMLElement, page: SvgBuilder): void
Inherited from AbstractSvgStylizer.addSingleCutline
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:195
Adds the passed line as a cutline that does not belong to any plate
Parameters:
| Name | Type | Description |
|---|---|---|
frameLine |
XMLElement | The svg line representing the line |
page |
SvgBuilder | The page where this line should be placed |
Returns: void
annotateGroupId
▸ annotateGroupId(): boolean
Overrides AbstractSvgStylizer.annotateGroupId
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:135
Returns: boolean
createGroupID
▸ createGroupID(group: PlateGroup, id: string, parent: any): XMLElement
Inherited from AbstractSvgStylizer.createGroupID
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:225
Parameters:
| Name | Type |
|---|---|
group |
PlateGroup |
id |
string |
parent |
any |
Returns: XMLElement
createJointID
▸ createJointID(plate: Plate, id: string, parent: any): XMLElement
Inherited from AbstractSvgStylizer.createJointID
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:235
Parameters:
| Name | Type |
|---|---|
plate |
Plate |
id |
string |
parent |
any |
Returns: XMLElement
createSymbolicLink
▸ createSymbolicLink(group: PlateGroup, id: string, parent: any, isReceiving: boolean): XMLElement
Inherited from AbstractSvgStylizer.createSymbolicLink
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:246
Parameters:
| Name | Type |
|---|---|
group |
PlateGroup |
id |
string |
parent |
any |
isReceiving |
boolean |
Returns: XMLElement
forceIds
▸ forceIds(): boolean
Overrides AbstractSvgStylizer.forceIds
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:123
Returns: boolean
getSvgPages
▸ getSvgPages(visiblePlates: Plate[]): ISvgPage[]
Inherited from AbstractSvgStylizer.getSvgPages
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:204
export the stylized svg pages
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
visiblePlates |
Plate[] | null | export only pages that contain one of these plates. exports all pages if this is not given |
Returns: ISvgPage[]
givingLinkSize
▸ givingLinkSize(): number
Overrides AbstractSvgStylizer.givingLinkSize
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:147
Returns: number
hasTabs
▸ hasTabs(): boolean
Overrides AbstractSvgStylizer.hasTabs
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:127
Returns: boolean
hideJointIds
▸ hideJointIds(): void
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:104
Returns: void
hidePlateContents
▸ hidePlateContents(page: any, plate: Plate): void
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:81
Parameters:
| Name | Type |
|---|---|
page |
any |
plate |
Plate |
Returns: void
hidePlateText
▸ hidePlateText(page: SvgBuilder, plate: Plate): void
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:97
Parameters:
| Name | Type |
|---|---|
page |
SvgBuilder |
plate |
Plate |
Returns: void
highlight
▸ highlight(highlighted: Plate[], hideNonHighlightedText: boolean): void
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:58
Parameters:
| Name | Type | Default |
|---|---|---|
highlighted |
Plate[] | - |
hideNonHighlightedText |
boolean | true |
Returns: void
idFontSize
▸ idFontSize(): number
Overrides AbstractSvgStylizer.idFontSize
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:139
Returns: number
jointIdFontSize
▸ jointIdFontSize(): number
Overrides AbstractSvgStylizer.jointIdFontSize
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:143
Returns: number
preProcessImage
▸ preProcessImage(context: CanvasRenderingContext2D, width: number, height: number): void
Overrides AbstractSvgStylizer.preProcessImage
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:171
Parameters:
| Name | Type |
|---|---|
context |
CanvasRenderingContext2D |
width |
number |
height |
number |
Returns: void
receivingLinkSize
▸ receivingLinkSize(): number
Overrides AbstractSvgStylizer.receivingLinkSize
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:151
Returns: number
registerPlate
▸ registerPlate(page: SvgBuilder, plate: Plate): void
Inherited from AbstractSvgStylizer.registerPlate
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:94
Registers a plate to a page
Parameters:
| Name | Type | Description |
|---|---|---|
page |
SvgBuilder | The builder of the page the plate is on |
plate |
Plate | The Plate object |
Returns: void
removePlates
▸ removePlates(removed: Plate[]): void
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:72
Parameters:
| Name | Type | Default |
|---|---|---|
removed |
Plate[] | [] |
Returns: void
renderAllPlates
▸ renderAllPlates(): Array‹object›
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:112
Returns: Array‹object›
rendersHoles
▸ rendersHoles(): boolean
Overrides AbstractSvgStylizer.rendersHoles
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:131
Returns: boolean
reset
▸ reset(): void
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:36
Returns: void
restyleSvgString
▸ restyleSvgString(svgString: string, isCutout: boolean): Promise‹string›
Overrides AbstractSvgStylizer.restyleSvgString
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/BookletSvgStylizer.ts:155
Parameters:
| Name | Type |
|---|---|
svgString |
string |
isCutout |
boolean |
Returns: Promise‹string›
setPageSize
▸ setPageSize(page: SvgBuilder, width: number, height: number): void
Inherited from AbstractSvgStylizer.setPageSize
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:85
Parameters:
| Name | Type |
|---|---|
page |
SvgBuilder |
width |
number |
height |
number |
Returns: void
setupPage
▸ setupPage(page: SvgBuilder, pageSize: IDimensions2, pageSizeChanged: boolean, material: IPlateMaterial): Promise‹void›
Inherited from AbstractSvgStylizer.setupPage
Defined in src/modules/kyub.core.svgObjExporter/src/export/SVGStyles/AbstractSvgStylizer.ts:72
Registers the size and material of a page
Parameters:
| Name | Type | Default |
|---|---|---|
page |
SvgBuilder | - |
pageSize |
IDimensions2 | - |
pageSizeChanged |
boolean | - |
material |
IPlateMaterial | { type: "poplar", thickness: 4 } |
Returns: Promise‹void›