IgxGeographicMapComponent

Represents the Infragistics IgxGeographicMapComponent control.

Constructors

new IgxGeographicMapComponent(_renderer: Renderer2, _elRef: ViewContainerRef, _ngZone: NgZone, _injector: Injector): IgxGeographicMapComponent

Returns IgxGeographicMapComponent

Properties

_dynamicContent

_dynamicContent: ViewContainerRef

actualSeries

The series actually present in the chart. Do not directly modify this array. This array's contents can be modified by causing Angular to reproject the child content. Or adding and removing series from the manual series collection on the series property.

actualSeries: IgxSeriesComponent[]

contentSeries

contentSeries: QueryList<IgxSeriesComponent>

ngAcceptInputType_actualWindowScale

ngAcceptInputType_actualWindowScale: string | number

ngAcceptInputType_actualWorldRect

ngAcceptInputType_actualWorldRect: any

ngAcceptInputType_backgroundTilingMode

ngAcceptInputType_backgroundTilingMode: string | MapBackgroundTilingMode

ngAcceptInputType_isHorizontalWrappingEnabled

ngAcceptInputType_isHorizontalWrappingEnabled: string | boolean

ngAcceptInputType_isMap

ngAcceptInputType_isMap: string | boolean

ngAcceptInputType_resizeBehavior

ngAcceptInputType_resizeBehavior: string | MapResizeBehavior

ngAcceptInputType_suppressZoomResetOnWorldRectChange

ngAcceptInputType_suppressZoomResetOnWorldRectChange: string | boolean

ngAcceptInputType_useWorldRectForZoomBounds

ngAcceptInputType_useWorldRectForZoomBounds: string | boolean

ngAcceptInputType_windowScale

ngAcceptInputType_windowScale: string | number

ngAcceptInputType_worldRect

ngAcceptInputType_worldRect: any

ngAcceptInputType_zoomable

ngAcceptInputType_zoomable: string | boolean

ngAcceptInputType_zoomIsReady

ngAcceptInputType_zoomIsReady: string | boolean

ɵcmp

ɵcmp: ɵɵComponentDeclaration<IgxGeographicMapComponent, "igx-geographic-map", never, object, object, ["contentSeries"], never, true, never>

ɵfac

ɵfac: ɵɵFactoryDeclaration<IgxGeographicMapComponent, never>

Accessors

actualWindowScale

A number between 0 and 1 determining the scale of the horizontal/vertical zoom. This property is effectively a shortcut to the Width/Height of the ActualWindowRect property.

get actualWindowScale(): number

Returns number

set actualWindowScale(v: number): void

Parameters

v: number

Returns void

actualWorldRect

Gets the actual value of the WorldRect.

get actualWorldRect(): IgRect

Returns IgRect

set actualWorldRect(v: IgRect): void

Parameters

v: IgRect

Returns void

backgroundContent

An imagery to display behind all series, inside the viewport of the IgxGeographicMapComponent control.

get backgroundContent(): IgxGeographicMapImagery

Returns IgxGeographicMapImagery

set backgroundContent(v: IgxGeographicMapImagery): void

Parameters

v: IgxGeographicMapImagery

Returns void

backgroundTilingMode

Gets or sets if the map should horizontally wrap.

get backgroundTilingMode(): MapBackgroundTilingMode

Returns MapBackgroundTilingMode

set backgroundTilingMode(v: MapBackgroundTilingMode): void

Parameters

v: MapBackgroundTilingMode

Returns void

dataSource

get dataSource(): any

Returns any

set dataSource(value: any): void

Parameters

value: any

Returns void

height

get height(): string

Returns string

set height(value: string): void

Parameters

value: string

Returns void

imageTilesReady

This event is fired whenever the image tiles transition from a loading state (e.g. some are fading in) to a loaded state.

get imageTilesReady(): EventEmitter<object>

Returns EventEmitter<object>

isHorizontalWrappingEnabled

Gets or sets if the map should horizontally wrap.

get isHorizontalWrappingEnabled(): boolean

Returns boolean

set isHorizontalWrappingEnabled(v: boolean): void

Parameters

v: boolean

Returns void

isMap

Indicates if this SeriesViewer is a map.

get isMap(): boolean

Returns boolean

legend

Gets or sets the legend used for the current chart.

get legend(): any

Returns any

set legend(v: any): void

Parameters

v: any

Returns void

resizeBehavior

Gets or sets the behavior to use during resize.

get resizeBehavior(): MapResizeBehavior

Returns MapResizeBehavior

set resizeBehavior(v: MapResizeBehavior): void

Parameters

v: MapResizeBehavior

Returns void

series

A collection or manually added series for the chart.

get series(): IgxSeriesCollection

Returns IgxSeriesCollection

suppressZoomResetOnWorldRectChange

Gets or sets whether skip resetting the zoom when the world rect changes.

get suppressZoomResetOnWorldRectChange(): boolean

Returns boolean

set suppressZoomResetOnWorldRectChange(v: boolean): void

Parameters

v: boolean

Returns void

useWorldRectForZoomBounds

Gets or sets whether to use the uncoerced world rect to constrain the zoom bounds.

get useWorldRectForZoomBounds(): boolean

Returns boolean

set useWorldRectForZoomBounds(v: boolean): void

Parameters

v: boolean

Returns void

width

get width(): string

Returns string

set width(value: string): void

Parameters

value: string

Returns void

windowScale

A number between 0 and 1 determining the scale of the horizontal/vertical zoom. This property is effectively a shortcut to the Width/Height of the WindowRect property.

get windowScale(): number

Returns number

set windowScale(v: number): void

Parameters

v: number

Returns void

worldRect

Gets or sets the world bounding rectangle.

get worldRect(): IgRect

Returns IgRect

set worldRect(v: IgRect): void

Parameters

v: IgRect

Returns void

xAxis

The X-axis for this IgxGeographicMap.Component Under normal circumstances, this property should not be set in application code. By default, it will be set to a numeric axis with a spherical mercator scaler.

get xAxis(): IgxNumericXAxisComponent

Returns IgxNumericXAxisComponent

set xAxis(v: IgxNumericXAxisComponent): void

Parameters

v: IgxNumericXAxisComponent

Returns void

yAxis

The Y-axis for this IgxGeographicMap.Component Under normal circumstances, this property should not be set in application code. By default, it will be set to a numeric axis with a spherical mercator scaler.

get yAxis(): IgxNumericYAxisComponent

Returns IgxNumericYAxisComponent

set yAxis(v: IgxNumericYAxisComponent): void

Parameters

v: IgxNumericYAxisComponent

Returns void

zoomable

Gets or sets zoomability of the current control

get zoomable(): boolean

Returns boolean

set zoomable(v: boolean): void

Parameters

v: boolean

Returns void

zoomIsReady

Gets whether or not the control is ready for zooming

get zoomIsReady(): boolean

Returns boolean

Methods

bindData

bindData(): void

Returns void

clearTileCache

Removes all cached tile images from the map imagery assigned to the map's background content.

clearTileCache(): void

Returns void

convertGeographicToZoom

convertGeographicToZoom(geographic: IgRect, extraPixelPadding: number): IgRect

Parameters

geographic: IgRect
extraPixelPadding: number

Returns IgRect

deferredRefresh

Calls for a deferred refresh to the GeographicMap's background.

deferredRefresh(): void

Returns void

exportVisualData

Returns the chart visuals expressed as a ChartVisualData object.

exportVisualData(): any

Returns any

findByName

findByName(name: string): any

Parameters

name: string

Returns any

getActualWindowScaleHorizontal

Gets actual window scale for horizontal dimension of the control

getActualWindowScaleHorizontal(): number

Returns number

getActualWindowScaleVertical

Gets actual window scale for vertical dimension of the control

getActualWindowScaleVertical(): number

Returns number

getCurrentActualWorldRect

Gets current world rect in geographic coordinates

getCurrentActualWorldRect(): IgRect

Returns IgRect

getGeographicFromZoom

Given a WindowRect and the current plot area, get the geographic region represented by that WindowRect.

getGeographicFromZoom(windowRect: IgRect): IgRect

Parameters

windowRect: IgRect
- The zoom area.

Returns IgRect

getGeographicPoint

Convert a pixel-based coordinate to a geographic coordinate.

getGeographicPoint(pixelCoordinate: IgPoint): IgPoint

Parameters

pixelCoordinate: IgPoint
- A pixel-based coordinate

Returns IgPoint

getPixelPoint

Convert a geographic coordinate to a pixel-based coordinate.

getPixelPoint(geographicCoordinate: IgPoint): IgPoint

Parameters

geographicCoordinate: IgPoint
- A geographic coordinate

Returns IgPoint

getWindowPoint

Convert a geographic coordinate to a pixel-based coordinate.

getWindowPoint(geographicCoordinate: IgPoint): IgPoint

Parameters

geographicCoordinate: IgPoint
- A geographic coordinate

Returns IgPoint

getZoomFromGeographicPoints

getZoomFromGeographicPoints(northWest: IgPoint, southEast: IgPoint): IgRect

Parameters

northWest: IgPoint
southEast: IgPoint

Returns IgRect

getZoomFromGeographicRect

Given the current plot area of the control and a geographic region, get the WindowRect that would encompass that geographic region.

getZoomFromGeographicRect(geographic: IgRect): IgRect

Parameters

geographic: IgRect
- The geographic area.

Returns IgRect

getZoomRectFromGeoRect

Given the current plot area of the control and a geographic region, get the WindowRect that would encompass that geographic region.

getZoomRectFromGeoRect(geographic: IgRect): IgRect

Parameters

geographic: IgRect
- The geographic area.

Returns IgRect

ngAfterContentInit

ngAfterContentInit(): void

Returns void

ngOnDestroy

ngOnDestroy(): void

Returns void

styleUpdated

Notifies the chart that the CSS styles in effect have been updated.

styleUpdated(): void

Returns void

updateWorldRect

Updates world rect in geographic coordinates

updateWorldRect(worldRect: IgRect): void

Parameters

worldRect: IgRect

Returns void

updateZoomWindow

Updates zoom window using window coordinates

updateZoomWindow(zoomWindow: IgRect): void

Parameters

zoomWindow: IgRect

Returns void

zoomToGeographic

Zoom in to the geographic region specified, when possible (may need to wait for map to be initialized).

zoomToGeographic(geographic: IgRect): void

Parameters

geographic: IgRect
- The geographic region to zoom to.