UI element class used to display AzureMaps imagery in the GeographicMap.

Constructors

Section titled "Constructors"

IgrAzureMapsImagery 

new IgrAzureMapsImagery(): IgrAzureMapsImagery

Returns IgrAzureMapsImagery

Accessors

Section titled "Accessors"

apiKey

Section titled "apiKey"

Gets or sets a subscription key required by the Azure Maps imagery service. For more information see https://learn.microsoft.com/en-us/azure/azure-maps/azure-maps-authentication#shared-key-authentication.

 
get apiKey(): string

Returns string 

set apiKey(v: string): void

Parameters

  • v: string

Returns void

apiVersion

Section titled "apiVersion"

Gets or sets the API version used by the Azure Maps imagery service. For more information see Render API version in https://learn.microsoft.com/en-us/azure/azure-maps/rest-api-azure-maps#latest-release.

 
get apiVersion(): string

Returns string 

set apiVersion(v: string): void

Parameters

  • v: string

Returns void

cancellingImage

Section titled "cancellingImage"

Inherited from: IgrGeographicMapImagery

Event raised when an image is being downloaded.

 
get cancellingImage(): object

Returns object 

set cancellingImage(ev: object): void

Parameters

  • ev: object

Returns void

cultureName

Section titled "cultureName"

Gets or sets the culture name for this tile source.

 
get cultureName(): string

Returns string 

set cultureName(v: string): void

Parameters

  • v: string

Returns void

deferralHandler

Section titled "deferralHandler"

Inherited from: IgrGeographicMapImagery

The deferral handler to use for deferred refreshes.

 
get deferralHandler(): IMapRenderDeferralHandler

Returns IMapRenderDeferralHandler 

set deferralHandler(v: IMapRenderDeferralHandler): void

Parameters

  • v: IMapRenderDeferralHandler

Returns void

downloadingImage

Section titled "downloadingImage"

Inherited from: IgrGeographicMapImagery

Event raised when an image is being downloaded.

 
get downloadingImage(): object

Returns object 

set downloadingImage(ev: object): void

Parameters

  • ev: object

Returns void

geographicMap

Section titled "geographicMap"

Inherited from: IgrGeographicMapImagery

The GeographicMapComponent which is hosting this GeographicMapImagery control.

 
get geographicMap(): IgrGeographicMap

Returns IgrGeographicMap 

set geographicMap(v: IgrGeographicMap): void

Parameters

Returns void

imageryStyle

Section titled "imageryStyle"

Gets or sets a map style of the Azure Maps imagery tiles. For example: Road map style.

 
get imageryStyle(): AzureMapsImageryStyle

Returns AzureMapsImageryStyle 

set imageryStyle(v: AzureMapsImageryStyle): void

Parameters

Returns void

imagesChanged

Section titled "imagesChanged"

Inherited from: IgrGeographicMapImagery

Event raised when tile images have changed.

 
get imagesChanged(): object

Returns object 

set imagesChanged(ev: object): void

Parameters

  • ev: object

Returns void

imageTilesReady

Section titled "imageTilesReady"

Inherited from: IgrGeographicMapImagery

Event raised when the image tiles have been downloaded.

 
get imageTilesReady(): object

Returns object 

set imageTilesReady(ev: object): void

Parameters

  • ev: object

Returns void

isHorizontalWrappingEnabled

Section titled "isHorizontalWrappingEnabled"

Inherited from: IgrGeographicMapImagery

Gets or sets if horizontal wrapping is enabled for the imagery.

 
get isHorizontalWrappingEnabled(): boolean

Returns boolean 

set isHorizontalWrappingEnabled(v: boolean): void

Parameters

  • v: boolean

Returns void

localizedView

Section titled "localizedView"

Gets or sets a string that specifies which maps to show for geopolitically disputed regions. For more information see https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tile#localizedmapview.

 
get localizedView(): string

Returns string 

set localizedView(v: string): void

Parameters

  • v: string

Returns void

nativeElement

Section titled "nativeElement"

Inherited from: IgrGeographicMapImagery 

get nativeElement(): HTMLElement

Returns HTMLElement

opacity

Section titled "opacity"

Inherited from: IgrGeographicMapImagery 

get opacity(): number

Returns number 

set opacity(v: number): void

Parameters

  • v: number

Returns void

referer

Section titled "referer"

Inherited from: IgrGeographicMapImagery

Gets or sets the referer sent in the headers of the tile request.

 
get referer(): string

Returns string 

set referer(v: string): void

Parameters

  • v: string

Returns void

timestamp

Section titled "timestamp"

Gets or sets a specific date and time for the map. Note that not all tilesets support this option and those that do might have restrictions. For more information see https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tile#uri-parameters.

 
get timestamp(): Date

Returns Date 

set timestamp(v: Date): void

Parameters

  • v: Date

Returns void

userAgent

Section titled "userAgent"

Inherited from: IgrGeographicMapImagery

Gets or sets the UserAgent sent in the headers of the tile request.

 
get userAgent(): string

Returns string 

set userAgent(v: string): void

Parameters

  • v: string

Returns void

windowRect

Section titled "windowRect"

Inherited from: IgrGeographicMapImagery

A rectangle representing the portion of the map imagery currently in view. A rectangle at X=0, Y=0 with a Height and Width of 1 implies the entire plotting area is in view. A Height and Width of .5 would imply that the view is halfway zoomed in.

 
get windowRect(): IgRect

Returns IgRect 

set windowRect(v: IgRect): void

Parameters

  • v: IgRect

Returns void

Methods

Section titled "Methods"

clearTileCache

Section titled "clearTileCache"

Inherited from: IgrGeographicMapImagery

Removes all cached tile Imagery from the

 
clearTileCache(): void

Returns void

findByName

Section titled "findByName"

Inherited from: IgrGeographicMapImagery 

findByName(name: string): any

Parameters

  • name: string

Returns any

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgrGeographicMapImagery 

_createFromInternal(internal: any): IgrGeographicMapImagery

Parameters

  • internal: any

Returns IgrGeographicMapImagery