Class ImageItem

ImageItem is used to identify an image in the ImageCache.

Hierarchy

ImageItem

Index

Constructors

constructor

Properties

Accessors

Methods

loadImage

Constructors

constructor

new ImageItem(url: string, image?: TexturizableImage): ImageItem

- Defined in @here/harp-mapview/lib/image/Image.ts:32
Create the ImageItem.

Parameters
- url: string
  
  URL of the image, or unique identifier.
- Optional image: TexturizableImage
  
  Optional image if already loaded.
Returns ImageItem

Properties

Optional cancelled

cancelled: undefined | false | true

Turns to true if the loading has been cancelled.

Optional image

image: TexturizableImage

Optional image if already loaded.

Optional mipMaps

mipMaps: ImageData[]

Mip maps for image data

Readonly url

url: string

URL of the image, or unique identifier.

Accessors

loaded

get loaded(): boolean

- Defined in @here/harp-mapview/lib/image/Image.ts:42
Returns boolean

loading

get loading(): boolean

- Defined in @here/harp-mapview/lib/image/Image.ts:46
Returns boolean

Methods

loadImage

loadImage(): Promise<ImageItem | undefined>

- Defined in @here/harp-mapview/lib/image/Image.ts:59
Load an ImageItem.

remarks

If the loading process is already running, it returns the current promise.

Returns Promise<ImageItem | undefined>

An ImageItem if the image has already been loaded, a promise otherwise.

Generated using TypeDoc