Class SignToolStorage

Signature tool storage.

Hierarchy

SignToolStorage

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new SignToolStorage(ownerUserName: string): SignToolStorage

Create signature tool storage for the user specified by the ownerUserName argument.

Parameters
- ownerUserName: string
Returns SignToolStorage

Accessors

settings

get settings(): SignToolSettings | undefined

Gets the signature tool settings saved in browser's local storage.

Returns SignToolSettings | undefined

storageKey

get storageKey(): string

Local storage's key which is used to store/retrieve signature settings object.

Returns string

Methods

loadImage

loadImage(signToolType: SignToolType, canvas: HTMLCanvasElement): Promise<HTMLImageElement | null>

Restore image from local storage.

Parameters
- signToolType: SignToolType
- canvas: HTMLCanvasElement
Returns Promise<HTMLImageElement | null>

loadSignaturePad

loadSignaturePad(signToolType: SignToolType, signaturePad: SignaturePad): Promise<boolean>

Load signature pad from local storage.

Parameters
- signToolType: SignToolType
- signaturePad: SignaturePad
Returns Promise<boolean>

reset

reset(): void

Clear whole signature storage data.

Returns void

resetCanvasImage

resetCanvasImage(toolType: SignToolType): void

Clear previously stored canvas image for tool given by argument toolType.

Parameters
- toolType: SignToolType
Returns void

resetCanvasImages

resetCanvasImages(): void

Clear all previously stored canvas images.

Returns void

saveCanvas

saveCanvas(toolType: SignToolType, canvas: HTMLCanvasElement, signaturePad?: SignaturePad): void

Save image data from canvas element into local storage.

Parameters
- toolType: SignToolType
- canvas: HTMLCanvasElement
- Optional signaturePad: SignaturePad
Returns void

saveImage

saveImage(signToolType: SignToolType, img: HTMLImageElement): void

Save image data into local storage.

Parameters
- signToolType: SignToolType
- img: HTMLImageElement
  
  Image element
Returns void

setSetting

setSetting(settingName: string, value: any): void

Save setting value in local storage.

Parameters
- settingName: string
- value: any
Returns void