new SheetBook()
SheetBook consists of many sheets, each sheet contains shapes, images and drawing etc.
- Source:
Methods
addSheet(_sheet)
This Function add sheets to existing sheetbook
Parameters:
| Name | Type | Description |
|---|---|---|
_sheet |
Sheet |
- Source:
Returns:
- nothing
getCombinedImage() → {String}
This Function converts all the sheets within a SheetBook into a single combined image
- Source:
Returns:
- dataURL - This Data Url can be directly used within an image element of an HTML
- Type
- String
getCurrentSheet() → {Sheet}
This Function retrieves currently active Sheet in the SheetBook
- Source:
Returns:
- currentSheet
- Type
- Sheet
getSheet(_sheetName)
This Function retrieves a sheet from SheetBook with a given name
Parameters:
| Name | Type | Description |
|---|---|---|
_sheetName |
String |
- Source:
Returns:
- nothing
setAnchorElement(_anchor)
This Function sets HTML Dom element as parent anchor
This is useful to put a sheetbook inside external HTML
Parameters:
| Name | Type | Description |
|---|---|---|
_anchor |
HTMLElement |
- Source:
Returns:
- nothing
setCurrentSheet(_sheet)
This Function sets a sheet as active and current Sheet within the SheetBook
Parameters:
| Name | Type | Description |
|---|---|---|
_sheet |
Sheet |
- Source:
Returns:
- nothing
setHeight(_height)
This Function sets the height in pixel of the SheetBook
Parameters:
| Name | Type | Description |
|---|---|---|
_height |
Number |
- Source:
Returns:
- nothing
setWidth(_width)
This Function sets the width in pixel for the SheetBook
Parameters:
| Name | Type | Description |
|---|---|---|
_width |
Number |
- Source:
Returns:
- nothing
zoom()
This Function allows propotionate zoom of the entire SheetBook
Underconstruction - not ready yet
- Source: