Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcArcGISOnlineMapImagery

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

Hierarchy

Hierarchy (view full)

Constructors

Accessors

Methods

Constructors

constructor

Accessors

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

defaultTokenTimeout

  • get defaultTokenTimeout(): number

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

    Returns number

  • set defaultTokenTimeout(v): void

  • Parameters

    • v: number

    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

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

isMapPublic

  • get isMapPublic(): boolean

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

    Returns boolean

  • set isMapPublic(v): void

  • Parameters

    • v: boolean

    Returns void

mapServerUri

  • get mapServerUri(): string

  • Gets or sets the map tile server uri.

    Returns string

  • set mapServerUri(v): void

  • Parameters

    • v: string

    Returns void

opacity

  • get opacity(): number

  • Returns number

  • set opacity(v): void

  • Parameters

    • v: number

    Returns void

password

  • get password(): string

  • Gets or sets the Password.

    Returns string

  • set password(v): void

  • Parameters

    • v: string

    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

refererUri

  • get refererUri(): string

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

    Returns string

  • set refererUri(v): void

  • Parameters

    • v: string

    Returns void

tokenGenerationEndPoint

  • get tokenGenerationEndPoint(): string

  • Gets or Sets the current endpoint to retrieve the token.

    Returns string

  • set tokenGenerationEndPoint(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

userName

  • get userName(): string

  • Gets or sets the UserName.

    Returns string

  • set userName(v): void

  • Parameters

    • v: string

    Returns void

userToken

  • get userToken(): string

  • Gets or sets the UserToken.

    Returns string

  • set userToken(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

acquireNewToken

  • acquireNewToken(): void

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

    Returns void

clearTileCache

  • clearTileCache(): void

  • Removes all cached tile Imagery from the

    Returns void

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any

Static _createFromInternal