Class RasterImageModel

A model that can provide access to raster images. To visualize such a model in a Map, use a RasterImageLayer.

There are two implementations: GoogleImageModel and WMSImageModel.

Note that this is an "abstract" model and should never be instantiated directly. Only its subtypes can be directly instantiated.

RasterImageModel is not supported in hardware-accelerated map.

since: 2013.1

Hierarchy

Invalidation
- RasterImageModel
  - GoogleImageModel
  - WMSImageModel

Implements

Overview

Constructors

constructor

Events

on

Accessors

Methods

invalidate

Constructors

Protected constructor

(options?: RasterImageModelConstructorOptions): RasterImageModel

Creates a new image model with the given options. This is an "abstract" model and should never be instantiated directly.

Parameters
- Optional options: RasterImageModelConstructorOptions
  
  parameters to configure the RasterImageModel.
Returns RasterImageModel

Events

on

(event: "Invalidated", callback: (...args: any[]) => void, context?: any): Handle

Overrides Invalidation.on

An event indicating that this Controller is invalidated. Invalidated means that data has changed and the visualization needs to be refreshed. This event fires when #invalidate is called.

Parameters
- event: "Invalidated"
- callback: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- Optional context: any
Returns Handle

Accessors

bounds

get bounds(): Bounds

Returns Bounds

coordinateType

get coordinateType(): CoordinateType

Returns CoordinateType

modelDescriptor

get modelDescriptor(): ModelDescriptor
set modelDescriptor(modelDescriptor: ModelDescriptor): void

Returns ModelDescriptor
Parameters
- modelDescriptor: ModelDescriptor
Returns any

reference

get reference(): CoordinateReference

Returns CoordinateReference

Methods

invalidate

(): void

Overrides Invalidation.invalidate

Signals that the underlying data for the tiled images has changed. If this model is added to a map using a RasterImageLayer, calling this method will thus trigger a refresh of the visualization.

Returns void

Legend

Module
Object literal
Variable
Function
Function with type parameter
Index signature
Type alias
Type alias with type parameter

Enumeration
Enumeration member
Property
Method

Interface
Interface with type parameter
Constructor
Property
Method
Index signature

Class
Class with type parameter
Constructor
Property
Method
Accessor
Index signature

Inherited constructor
Inherited property
Inherited method
Inherited accessor

Protected property
Protected method
Protected accessor

Private property
Private method
Private accessor

Static property
Static method