IgxBingMapsMapImagery

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

Constructors

new IgxBingMapsMapImagery(): IgxBingMapsMapImagery

Returns IgxBingMapsMapImagery

Properties

ngAcceptInputType_actualSubDomains

ngAcceptInputType_actualSubDomains: string | IgxSubDomainsCollection

ngAcceptInputType_imageryStyle

ngAcceptInputType_imageryStyle: string | BingMapsImageryStyle

ngAcceptInputType_isDeferredLoad

ngAcceptInputType_isDeferredLoad: string | boolean

ngAcceptInputType_isHorizontalWrappingEnabled

Inherited from: IgxGeographicMapImagery

ngAcceptInputType_isHorizontalWrappingEnabled: string | boolean

ngAcceptInputType_isInitialized

ngAcceptInputType_isInitialized: string | boolean

ngAcceptInputType_opacity

Inherited from: IgxGeographicMapImagery

ngAcceptInputType_opacity: string | number

ngAcceptInputType_subDomains

ngAcceptInputType_subDomains: string | IgxSubDomainsCollection

ngAcceptInputType_windowRect

Inherited from: IgxGeographicMapImagery

ngAcceptInputType_windowRect: any

Accessors

actualBingImageryRestUri

Gets or sets the Actual Bing Imagery Rest Uri.

get actualBingImageryRestUri(): string

Returns string

set actualBingImageryRestUri(v: string): void

Parameters

v: string

Returns void

actualSubDomains

Gets or sets the actual collection of image uri subdomains.

get actualSubDomains(): IgxSubDomainsCollection

Returns IgxSubDomainsCollection

set actualSubDomains(v: IgxSubDomainsCollection): void

Parameters

v: IgxSubDomainsCollection

Returns void

actualTilePath

Gets or sets the actual map tile image uri.

get actualTilePath(): string

Returns string

set actualTilePath(v: string): void

Parameters

v: string

Returns void

apiKey

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.

get apiKey(): string

Returns string

set apiKey(v: string): void

Parameters

v: string

Returns void

bingImageryRestUri

Gets or sets the Bing Imagery Rest Uri.

get bingImageryRestUri(): string

Returns string

set bingImageryRestUri(v: string): void

Parameters

v: string

Returns void

cancellingImage

Inherited from: IgxGeographicMapImagery

Event raised when an image is being downloaded.

get cancellingImage(): EventEmitter<object>

Returns EventEmitter<object>

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

Inherited from: IgxGeographicMapImagery

The deferral handler to use for deferred refreshes.

get deferralHandler(): IMapRenderDeferralHandler

Returns IMapRenderDeferralHandler

set deferralHandler(v: IMapRenderDeferralHandler): void

Parameters

v: IMapRenderDeferralHandler

Returns void

downloadingImage

Inherited from: IgxGeographicMapImagery

Event raised when an image is being downloaded.

get downloadingImage(): EventEmitter<object>

Returns EventEmitter<object>

geographicMap

Inherited from: IgxGeographicMapImagery

The IgxGeographicMapComponent which is hosting this GeographicMapImagery control.

get geographicMap(): IgxGeographicMapComponent

Returns IgxGeographicMapComponent

set geographicMap(v: IgxGeographicMapComponent): void

Parameters

v: IgxGeographicMapComponent

Returns void

imageryStyle

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

get imageryStyle(): BingMapsImageryStyle

Returns BingMapsImageryStyle

set imageryStyle(v: BingMapsImageryStyle): void

Parameters

v: BingMapsImageryStyle

Returns void

imagesChanged

Inherited from: IgxGeographicMapImagery

Event raised when tile images have changed.

get imagesChanged(): EventEmitter<object>

Returns EventEmitter<object>

imageTilesReady

Inherited from: IgxGeographicMapImagery

Event raised when the image tiles have been downloaded.

get imageTilesReady(): EventEmitter<object>

Returns EventEmitter<object>

isDeferredLoad

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

get isDeferredLoad(): boolean

Returns boolean

set isDeferredLoad(v: boolean): void

Parameters

v: boolean

Returns void

isHorizontalWrappingEnabled

Inherited from: IgxGeographicMapImagery

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

isInitialized

Gets a status whether the Bing Maps service is initialized.

get isInitialized(): boolean

Returns boolean

set isInitialized(v: boolean): void

Parameters

v: boolean

Returns void

opacity

Inherited from: IgxGeographicMapImagery

get opacity(): number

Returns number

set opacity(v: number): void

Parameters

v: number

Returns void

referer

Inherited from: IgxGeographicMapImagery

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

subDomains

Gets or sets the collection of image uri subdomains.

get subDomains(): IgxSubDomainsCollection

Returns IgxSubDomainsCollection

set subDomains(v: IgxSubDomainsCollection): void

Parameters

v: IgxSubDomainsCollection

Returns void

tilePath

Gets or sets the map tile image uri.

get tilePath(): string

Returns string

set tilePath(v: string): void

Parameters

v: string

Returns void

userAgent

Inherited from: IgxGeographicMapImagery

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

Inherited from: IgxGeographicMapImagery

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

clearTileCache

Inherited from: IgxGeographicMapImagery

Removes all cached tile Imagery from the

clearTileCache(): void

Returns void

findByName

Inherited from: IgxGeographicMapImagery

findByName(name: string): any

Parameters

name: string

Returns any

requestMapSettings

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.

requestMapSettings(): void

Returns void

_createFromInternal

Inherited from: IgxGeographicMapImagery

_createFromInternal(internal: any): IgxGeographicMapImagery

Parameters

internal: any

Constructors