Represents the Infragistics GeographicMapComponent control.

Constructors

Section titled "Constructors"

IgrGeographicMap 

new IgrGeographicMap(props: IIgrGeographicMapProps): IgrGeographicMap

Returns IgrGeographicMap

Properties

Section titled "Properties"

actualSeries

Section titled "actualSeries"

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

 
actualSeries: IgrSeries[]

contentSeries

Section titled "contentSeries" 
contentSeries: IgrSeries[]

Accessors

Section titled "Accessors"

actualWindowScale

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

Section titled "actualWorldRect"

Gets the actual value of the WorldRect.

 
get actualWorldRect(): IgRect

Returns IgRect 

set actualWorldRect(v: IgRect): void

Parameters

  • v: IgRect

Returns void

backgroundContent

Section titled "backgroundContent"

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

 
get backgroundContent(): IgrGeographicMapImagery

Returns IgrGeographicMapImagery 

set backgroundContent(v: IgrGeographicMapImagery): void

Parameters

Returns void

backgroundTilingMode

Section titled "backgroundTilingMode"

Gets or sets if the map should horizontally wrap.

 
get backgroundTilingMode(): MapBackgroundTilingMode

Returns MapBackgroundTilingMode 

set backgroundTilingMode(v: MapBackgroundTilingMode): void

Parameters

Returns void

dataSource

Section titled "dataSource" 
get dataSource(): any

Returns any 

set dataSource(value: any): void

Parameters

  • value: any

Returns void

height

Section titled "height" 
get height(): string

Returns string 

set height(value: string): void

Parameters

  • value: string

Returns void

imageTilesReady

Section titled "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(): object

Returns object 

set imageTilesReady(ev: object): void

Parameters

  • ev: object

Returns void

isHorizontalWrappingEnabled

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

Section titled "isMap"

Indicates if this SeriesViewer is a map.

 
get isMap(): boolean

Returns boolean

legend

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

Section titled "resizeBehavior"

Gets or sets the behavior to use during resize.

 
get resizeBehavior(): MapResizeBehavior

Returns MapResizeBehavior 

set resizeBehavior(v: MapResizeBehavior): void

Parameters

Returns void

series

Section titled "series"

A collection or manually added series for the chart.

 
get series(): IgrSeriesCollection

Returns IgrSeriesCollection

suppressZoomResetOnWorldRectChange

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

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

Section titled "width" 
get width(): string

Returns string 

set width(value: string): void

Parameters

  • value: string

Returns void

windowScale

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

Section titled "worldRect"

Gets or sets the world bounding rectangle.

 
get worldRect(): IgRect

Returns IgRect 

set worldRect(v: IgRect): void

Parameters

  • v: IgRect

Returns void

xAxis

Section titled "xAxis"

The X-axis for this GeographicMap.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(): IgrNumericXAxis

Returns IgrNumericXAxis 

set xAxis(v: IgrNumericXAxis): void

Parameters

  • v: IgrNumericXAxis

Returns void

yAxis

Section titled "yAxis"

The Y-axis for this GeographicMap.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(): IgrNumericYAxis

Returns IgrNumericYAxis 

set yAxis(v: IgrNumericYAxis): void

Parameters

  • v: IgrNumericYAxis

Returns void

zoomable

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

Section titled "zoomIsReady"

Gets whether or not the control is ready for zooming

 
get zoomIsReady(): boolean

Returns boolean

Methods

Section titled "Methods"

bindData

Section titled "bindData" 
bindData(): void

Returns void

clearTileCache

Section titled "clearTileCache"

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

 
clearTileCache(): void

Returns void

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

componentWillUnmount

Section titled "componentWillUnmount" 
componentWillUnmount(): void

Returns void

convertGeographicToZoom

Section titled "convertGeographicToZoom" 
convertGeographicToZoom(geographic: IgRect, extraPixelPadding: number): IgRect

Parameters

  • geographic: IgRect
  • extraPixelPadding: number

Returns IgRect

deferredRefresh

Section titled "deferredRefresh"

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

 
deferredRefresh(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

exportVisualData

Section titled "exportVisualData"

Returns the chart visuals expressed as a ChartVisualData object.

 
exportVisualData(): any

Returns any

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

getActualWindowScaleHorizontal

Section titled "getActualWindowScaleHorizontal"

Gets actual window scale for horizontal dimension of the control

 
getActualWindowScaleHorizontal(): number

Returns number

getActualWindowScaleVertical

Section titled "getActualWindowScaleVertical"

Gets actual window scale for vertical dimension of the control

 
getActualWindowScaleVertical(): number

Returns number

getCurrentActualWorldRect

Section titled "getCurrentActualWorldRect"

Gets current world rect in geographic coordinates

 
getCurrentActualWorldRect(): IgRect

Returns IgRect

getGeographicFromZoom

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

Section titled "getGeographicPoint"

Convert a pixel-based coordinate to a geographic coordinate.

 
getGeographicPoint(pixelCoordinate: IgPoint): IgPoint

Parameters

  • pixelCoordinate: IgPoint
    • A pixel-based coordinate

Returns IgPoint

getPixelPoint

Section titled "getPixelPoint"

Convert a geographic coordinate to a pixel-based coordinate.

 
getPixelPoint(geographicCoordinate: IgPoint): IgPoint

Parameters

  • geographicCoordinate: IgPoint
    • A geographic coordinate

Returns IgPoint

getWindowPoint

Section titled "getWindowPoint"

Convert a geographic coordinate to a pixel-based coordinate.

 
getWindowPoint(geographicCoordinate: IgPoint): IgPoint

Parameters

  • geographicCoordinate: IgPoint
    • A geographic coordinate

Returns IgPoint

getZoomFromGeographicPoints

Section titled "getZoomFromGeographicPoints" 
getZoomFromGeographicPoints(northWest: IgPoint, southEast: IgPoint): IgRect

Parameters

  • northWest: IgPoint
  • southEast: IgPoint

Returns IgRect

getZoomFromGeographicRect

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

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

initializeContent

Section titled "initializeContent" 
initializeContent(): void

Returns void

render

Section titled "render" 
render(): DetailedReactHTMLElement<object, any>

Returns DetailedReactHTMLElement<object, any>

styleUpdated

Section titled "styleUpdated"

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

 
styleUpdated(): void

Returns void

updateWorldRect

Section titled "updateWorldRect"

Updates world rect in geographic coordinates

 
updateWorldRect(worldRect: IgRect): void

Parameters

  • worldRect: IgRect

Returns void

updateZoomWindow

Section titled "updateZoomWindow"

Updates zoom window using window coordinates

 
updateZoomWindow(zoomWindow: IgRect): void

Parameters

  • zoomWindow: IgRect

Returns void

zoomToGeographic

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

Returns void