import ImageHandler from '@mapcreator/api/src/ImageHandler.js'

protected class | source

ImageHandler

Image resource handler

Constructor Summary

Public Constructor
public	constructor(api: Mapcreator, target: ResourceBase)

Member Summary

Public Members
public get	api: Mapcreator: * Get api instance
public get	url: string: string Resource url, can be used in an image tag

Method Summary

Public Methods
public	delete(): CancelablePromise Delete image
public	download(): CancelablePromise<DownloadedResource> Download the image
public	upload(image: ArrayBuffer \| ArrayBufferView \| File \| Blob \| Buffer): CancelablePromise Upload new image

Public Constructors

public constructor(api: Mapcreator, target: ResourceBase) source

Params:

Name	Type	Attribute	Description
api	Mapcreator		Api instance
target	ResourceBase		Instance of target item

Public Members

public get api: Mapcreator: * source

Get api instance

Return:

Mapcreator

Api instance

public get url: string: string source

Resource url, can be used in an image tag

Return:

string

Resource url

Public Methods

public delete(): CancelablePromise source

Delete image

Return:

CancelablePromise

Throw:

ApiError

If the api returns errors

public download(): CancelablePromise<DownloadedResource> source

Download the image

Return:

CancelablePromise<DownloadedResource>

image

Throw:

ApiError

If the api returns errors

Example:

// Browser
layer.imageHandler.download().then(image => {
  $('img').src = image.createObjectURL();
});

// NodeJs
layer.imageHandler.download().then({fileName, data} => {
  fs.writeFileSync(fileName, data);
});

public upload(image: ArrayBuffer | ArrayBufferView | File | Blob | Buffer): CancelablePromise source

Upload new image

Params:

Name	Type	Attribute	Description
image	ArrayBuffer \| ArrayBufferView \| File \| Blob \| Buffer		Image file

Return:

CancelablePromise

Throw:

ApiError

If the api returns errors