Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrAzureMapsImagery

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

Hierarchy

Hierarchy

Constructors

Accessors

Methods

Constructors

constructor

Accessors

apiKey

apiVersion

  • get apiVersion(): string

  • 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.

    Returns string

  • set apiVersion(v): void

  • Parameters

    • v: string

    Returns void

cancellingImage

  • get cancellingImage(): ((s, e) => void)

  • Event raised when an image is being downloaded.

    Returns ((s, e) => void)

      • (s, e): void

      • Event raised when an image is being downloaded.

        Parameters

        Returns void

  • set cancellingImage(ev): void

  • Parameters

    • ev: ((s, e) => void)

    Returns void

cultureName

  • get cultureName(): string

  • Gets or sets the culture name for this tile source.

    Returns string

  • set cultureName(v): void

  • Parameters

    • v: string

    Returns void

deferralHandler

  • get deferralHandler(): IMapRenderDeferralHandler

  • The deferral handler to use for deferred refreshes.

    Returns IMapRenderDeferralHandler

  • set deferralHandler(v): void

  • Parameters

    • v: IMapRenderDeferralHandler

    Returns void

downloadingImage

  • get downloadingImage(): ((s, e) => void)

  • Event raised when an image is being downloaded.

    Returns ((s, e) => void)

      • (s, e): void

      • Event raised when an image is being downloaded.

        Parameters

        Returns void

  • set downloadingImage(ev): void

  • Parameters

    • ev: ((s, e) => void)

    Returns void

geographicMap

  • get geographicMap(): IgrGeographicMap

  • The IgxGeographicMapComponent which is hosting this GeographicMapImagery control.

    Returns IgrGeographicMap

  • set geographicMap(v): void

  • Parameters

    Returns void

imageTilesReady

  • get imageTilesReady(): ((s, e) => void)

  • Event raised when the image tiles have been downloaded.

    Returns ((s, e) => void)

  • set imageTilesReady(ev): void

  • Parameters

    Returns void

imageryStyle

  • get imageryStyle(): AzureMapsImageryStyle

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

    Returns AzureMapsImageryStyle

  • set imageryStyle(v): void

  • Parameters

    Returns void

imagesChanged

  • get imagesChanged(): ((s, e) => void)

  • Event raised when tile images have changed.

    Returns ((s, e) => void)

  • set imagesChanged(ev): void

  • Parameters

    Returns void

isHorizontalWrappingEnabled

  • get isHorizontalWrappingEnabled(): boolean

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

    Returns boolean

  • set isHorizontalWrappingEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

localizedView

  • get localizedView(): string

  • 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.

    Returns string

  • set localizedView(v): void

  • Parameters

    • v: string

    Returns void

nativeElement

  • get nativeElement(): HTMLElement

  • Returns HTMLElement

opacity

  • get opacity(): number

  • Returns number

  • set opacity(v): void

  • Parameters

    • v: number

    Returns void

referer

  • get referer(): string

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

    Returns string

  • set referer(v): void

  • Parameters

    • v: string

    Returns void

timestamp

  • get timestamp(): Date

  • 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.

    Returns Date

  • set timestamp(v): void

  • Parameters

    • v: Date

    Returns void

userAgent

  • get userAgent(): string

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

    Returns string

  • set userAgent(v): void

  • Parameters

    • v: string

    Returns void

windowRect

  • get windowRect(): IgRect

  • 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.

    Returns IgRect

  • set windowRect(v): void

  • Parameters

    • v: IgRect

    Returns void

Methods

clearTileCache

  • Removes all cached tile Imagery from the

    Returns void

findByName

  • Parameters

    • name: string

    Returns any

Static _createFromInternal