Class CanvasKitCanvasAdapter

Node based canvas creation

Hierarchy

CanvasKitCanvasAdapter

Implements

CanvasAdapter

Constructors

constructor

new CanvasKitCanvasAdapter(): CanvasKitCanvasAdapter
Returns CanvasKitCanvasAdapter

Properties

`Static` canvasKitWasmLocateFile

canvasKitWasmLocateFile: ((filename: string) => string) = ...

Type declaration

- (filename: string): string
- Parameters
  - filename: string
  Returns string

Methods

create

create(width: number, height: number): EmulatedCanvas2D
Create a canvas with dimensions set to the provided width and height

Returns
canvas
Parameters
- width: number
- height: number
Returns EmulatedCanvas2D
Implementation of CanvasAdapter.create
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:83

createImage

createImage(imageData: string | Buffer | Uint8Array | Blob, contentType: string): Promise<GeoPackageImage>
Supports creating an image from file, base64 encoded image, image data buffer or url
Parameters
- imageData: string | Buffer | Uint8Array | Blob
- contentType: string
Returns Promise<GeoPackageImage>
Implementation of CanvasAdapter.createImage
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:93

createImageData

createImageData(width: any, height: any): ImageData
Creates an ImageData object
Parameters
- width: any
- height: any
Returns ImageData
Implementation of CanvasAdapter.createImageData
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:155

disposeCanvas

disposeCanvas(canvas: EmulatedCanvas2D): void
Performs any cleanup needed for the specified canvas. The canvas should not be used after calling this function.
Parameters
- canvas: EmulatedCanvas2D
Returns void
Implementation of CanvasAdapter.disposeCanvas
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:162

disposeImage

disposeImage(image: GeoPackageImage): void
Performs any cleanup needed for the specified image
Parameters
- image: GeoPackageImage
Returns void
Implementation of CanvasAdapter.disposeImage
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:239

drawText

drawText(context: any, text: string, location: number[], fontFace: string, fontSize: number, fontColor: string): void
Draws text centered at the location specified in the canvas rendering context
Parameters
- context: any
- text: string
- location: number[]
- fontFace: string
- fontSize: number
- fontColor: string
Returns void
Implementation of CanvasAdapter.drawText
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:187

getImageData

getImageData(image: GeoPackageImage): ImageData
Gets the image data
Parameters
- image: GeoPackageImage
Returns ImageData
Implementation of CanvasAdapter.getImageData
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:272

getTypeForImageFormat

getTypeForImageFormat(imageFormat: ImageType): EmbindEnumEntity
Gets the type for the image format
Parameters
- imageFormat: ImageType
Returns EmbindEnumEntity
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:293

initialize

initialize(): Promise<void>
Initializes the adapter for use.

Returns Promise<void>
Implementation of CanvasAdapter.initialize
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:38

isInitialized

isInitialized(): boolean
Returns if the Adapter has been initialized.

Returns boolean
Implementation of CanvasAdapter.isInitialized
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:73

measureText

measureText(context: any, fontFace: string, fontSize: number, text: string): number
Returns the width of the text in the given font face and font size
Parameters
- context: any
- fontFace: string
- fontSize: number
- text: string
Returns number
Implementation of CanvasAdapter.measureText
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:172

mergeCanvas

mergeCanvas(fromCanvas: any, toContext: any): void
Draw content of fromCanvas into the toContext
Parameters
- fromCanvas: any
- toContext: any
Returns void
Implementation of CanvasAdapter.mergeCanvas
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:284

scaleImage

scaleImage(image: GeoPackageImage, scale: number): Promise<GeoPackageImage>
Scales an image created using this adapter.
Parameters
- image: GeoPackageImage
- scale: number
Returns Promise<GeoPackageImage>
Implementation of CanvasAdapter.scaleImage
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:214

scaleImageToDimensions

scaleImageToDimensions(image: GeoPackageImage, scaledWidth: number, scaledHeight: number): Promise<GeoPackageImage>
Scales an image created using this adapter.
Parameters
- image: GeoPackageImage
- scaledWidth: number
- scaledHeight: number
Returns Promise<GeoPackageImage>
Implementation of CanvasAdapter.scaleImageToDimensions
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:223

toBytes

toBytes(canvas: any, imageFormat?: ImageType, compressionQuality?: number): Promise<Uint8Array>
Converts the contents drawn in a canvas to a byte array

Returns
Promise
Parameters
- canvas: any
- imageFormat: ImageType = ImageType.PNG
- compressionQuality: number = 100
Returns Promise<Uint8Array>
Implementation of CanvasAdapter.toBytes
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:322

toDataURL

toDataURL(canvas: any, format?: string, compressionQuality?: number): Promise<string>
Converts the canvas to a base64 data url in the format specified
Parameters
- canvas: any
- format: string = 'image/png'
- Optional compressionQuality: number
  
  0 to 1
Returns Promise<string>
Implementation of CanvasAdapter.toDataURL
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:207

writeImageToBytes

writeImageToBytes(image: GeoPackageImage, imageFormat: ImageType, compressionQuality?: number): Promise<Uint8Array>
Writes the GeoPackageImage to a buffer
Parameters
- image: GeoPackageImage
- imageFormat: ImageType
- compressionQuality: number = 0.92
Returns Promise<Uint8Array>
Implementation of CanvasAdapter.writeImageToBytes
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:256

`Static` setCanvasKit

setCanvasKit(CanvasKit: any): void
Parameters
- CanvasKit: any
Returns void
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:30

`Static` setCanvasKitWasmLocateFile

setCanvasKitWasmLocateFile(locateFile: ((filename: string) => string)): void
Parameters
- locateFile: ((filename: string) => string)
  - - (filename: string): string
    - Parameters
      
      filename: string
      
      Returns string
Returns void
- Defined in lib/canvas/canvasKitCanvasAdapter.ts:25

Generated using TypeDoc