Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcBingMapsMapImagery

UI element class used to display BingMapsMap imagery in the IgxGeographicMap.Component

Hierarchy

Hierarchy (view full)

Constructors

Accessors

Methods

Constructors

constructor

Accessors

actualBingImageryRestUri

  • get actualBingImageryRestUri(): string

  • Gets or sets the Actual Bing Imagery Rest Uri.

    Returns string

  • set actualBingImageryRestUri(v): void

  • Parameters

    • v: string

    Returns void

actualSubDomains

  • get actualSubDomains(): IgcSubDomainsCollection

  • Gets or sets the actual collection of image uri subdomains.

    Returns IgcSubDomainsCollection

  • set actualSubDomains(v): void

  • Parameters

    Returns void

actualTilePath

  • get actualTilePath(): string

  • Gets or sets the actual map tile image uri.

    Returns string

  • set actualTilePath(v): void

  • Parameters

    • v: string

    Returns void

apiKey

  • get apiKey(): string

  • Gets or sets an API key required by the Bing Maps imagery service. This key must be obtained from the http://www.bingmapsportal.com website.

    Returns string

  • set apiKey(v): void

  • Parameters

    • v: string

    Returns void

bingImageryRestUri

  • get bingImageryRestUri(): string

  • Gets or sets the Bing Imagery Rest Uri.

    Returns string

  • set bingImageryRestUri(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)

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

  • set downloadingImage(ev): void

  • Parameters

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

    Returns void

geographicMap

  • get geographicMap(): IgcGeographicMapComponent

  • The IgxGeographicMapComponent which is hosting this GeographicMapImagery control.

    Returns IgcGeographicMapComponent

  • 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(): BingMapsImageryStyle

  • Gets or sets a map style of the Bing Maps imagery tiles. For example: Aerial, AerialWithLabels, or Road map style.

    Returns BingMapsImageryStyle

  • 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

isDeferredLoad

  • get isDeferredLoad(): boolean

  • Gets or sets whether the Bing Maps service should be auto-initialized upon valid property values.

    Returns boolean

  • set isDeferredLoad(v): void

  • Parameters

    • v: boolean

    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

isInitialized

  • get isInitialized(): boolean

  • Gets a status whether the Bing Maps service is initialized.

    Returns boolean

  • set isInitialized(v): void

  • Parameters

    • v: boolean

    Returns void

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

subDomains

  • get subDomains(): IgcSubDomainsCollection

  • Gets or sets the collection of image uri subdomains.

    Returns IgcSubDomainsCollection

  • set subDomains(v): void

  • Parameters

    Returns void

tilePath

  • get tilePath(): string

  • Gets or sets the map tile image uri.

    Returns string

  • set tilePath(v): void

  • Parameters

    • v: string

    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

  • clearTileCache(): void

  • Removes all cached tile Imagery from the

    Returns void

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any

requestMapSettings

  • requestMapSettings(): void

  • Will Connect to the Bing Rest API and retrieve the required TilePath and Subdomains from the service. This requires a valid API key to already be set.

    Returns void

Static _createFromInternal