UI element class used to display ArcGIS Online Map imagery in the IgxGeographicMap.Component

Constructors

Section titled "Constructors"

IgxArcGISOnlineMapImagery 

new IgxArcGISOnlineMapImagery(): IgxArcGISOnlineMapImagery

Returns IgxArcGISOnlineMapImagery

Properties

Section titled "Properties"

ngAcceptInputType_defaultTokenTimeout

Section titled "ngAcceptInputType_defaultTokenTimeout" 
ngAcceptInputType_defaultTokenTimeout: string | number

ngAcceptInputType_isHorizontalWrappingEnabled

Section titled "ngAcceptInputType_isHorizontalWrappingEnabled"

Inherited from: IgxGeographicMapImagery 

ngAcceptInputType_isHorizontalWrappingEnabled: string | boolean

ngAcceptInputType_isMapPublic

Section titled "ngAcceptInputType_isMapPublic" 
ngAcceptInputType_isMapPublic: string | boolean

ngAcceptInputType_opacity

Section titled "ngAcceptInputType_opacity"

Inherited from: IgxGeographicMapImagery 

ngAcceptInputType_opacity: string | number

ngAcceptInputType_windowRect

Section titled "ngAcceptInputType_windowRect"

Inherited from: IgxGeographicMapImagery 

ngAcceptInputType_windowRect: any

Accessors

Section titled "Accessors"

cancellingImage

Section titled "cancellingImage"

Inherited from: IgxGeographicMapImagery

Event raised when an image is being downloaded.

 
get cancellingImage(): EventEmitter<object>

Returns EventEmitter<object>

defaultTokenTimeout

Section titled "defaultTokenTimeout"

Gets or Sets the Default Token Timeout before the Token Expires, this value is in Minutes

 
get defaultTokenTimeout(): number

Returns number 

set defaultTokenTimeout(v: number): void

Parameters

  • v: number

Returns void

deferralHandler

Section titled "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

Section titled "downloadingImage"

Inherited from: IgxGeographicMapImagery

Event raised when an image is being downloaded.

 
get downloadingImage(): EventEmitter<object>

Returns EventEmitter<object>

geographicMap

Section titled "geographicMap"

Inherited from: IgxGeographicMapImagery

The IgxGeographicMapComponent which is hosting this GeographicMapImagery control.

 
get geographicMap(): IgxGeographicMapComponent

Returns IgxGeographicMapComponent 

set geographicMap(v: IgxGeographicMapComponent): void

Parameters

Returns void

imagesChanged

Section titled "imagesChanged"

Inherited from: IgxGeographicMapImagery

Event raised when tile images have changed.

 
get imagesChanged(): EventEmitter<object>

Returns EventEmitter<object>

imageTilesReady

Section titled "imageTilesReady"

Inherited from: IgxGeographicMapImagery

Event raised when the image tiles have been downloaded.

 
get imageTilesReady(): EventEmitter<object>

Returns EventEmitter<object>

isHorizontalWrappingEnabled

Section titled "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

isMapPublic

Section titled "isMapPublic"

Gets or sets the IsMapPublic variable. A value of false requires authentication parameters.

 
get isMapPublic(): boolean

Returns boolean 

set isMapPublic(v: boolean): void

Parameters

  • v: boolean

Returns void

mapServerUri

Section titled "mapServerUri"

Gets or sets the map tile server uri.

 
get mapServerUri(): string

Returns string 

set mapServerUri(v: string): void

Parameters

  • v: string

Returns void

opacity

Section titled "opacity"

Inherited from: IgxGeographicMapImagery 

get opacity(): number

Returns number 

set opacity(v: number): void

Parameters

  • v: number

Returns void

password

Section titled "password"

Gets or sets the Password.

 
get password(): string

Returns string 

set password(v: string): void

Parameters

  • v: string

Returns void

referer

Section titled "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

refererUri

Section titled "refererUri"

Contains the User Supplied Referer Uri to be used in Token Generation.

 
get refererUri(): string

Returns string 

set refererUri(v: string): void

Parameters

  • v: string

Returns void

tokenGenerationEndPoint

Section titled "tokenGenerationEndPoint"

Gets or Sets the current endpoint to retrieve the token.

 
get tokenGenerationEndPoint(): string

Returns string 

set tokenGenerationEndPoint(v: string): void

Parameters

  • v: string

Returns void

userAgent

Section titled "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

userName

Section titled "userName"

Gets or sets the UserName.

 
get userName(): string

Returns string 

set userName(v: string): void

Parameters

  • v: string

Returns void

userToken

Section titled "userToken"

Gets or sets the UserToken.

 
get userToken(): string

Returns string 

set userToken(v: string): void

Parameters

  • v: string

Returns void

windowRect

Section titled "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

Section titled "Methods"

acquireNewToken

Section titled "acquireNewToken"

Retreives a new token based on the preconfigured parameters and updates the UserToken field, Normal this is called automatically. The is provided to the end-user to allow them to reteive tokens on their onw.

 
acquireNewToken(): void

Returns void

clearTileCache

Section titled "clearTileCache"

Inherited from: IgxGeographicMapImagery

Removes all cached tile Imagery from the

 
clearTileCache(): void

Returns void

findByName

Section titled "findByName"

Inherited from: IgxGeographicMapImagery 

findByName(name: string): any

Parameters

  • name: string

Returns any

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgxGeographicMapImagery 

_createFromInternal(internal: any): IgxGeographicMapImagery

Parameters

  • internal: any

Returns IgxGeographicMapImagery