Class IgbGeographicMap

Represents the Infragistics IgbGeographicMap control.

Inheritance
System.Object
BaseRendererControl
IgbSeriesViewer
IgbGeographicMap
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbGeographicMap : IgbSeriesViewer, RefSink, JsonSerializable, IDisposable

Constructors

IgbGeographicMap()

Declaration
public IgbGeographicMap()

Properties

ActualWindowScale

A number between 0 and 1 determining the scale of the horizontal/vertical zoom.

Declaration
public double ActualWindowScale { get; set; }
Property Value
Type Description
System.Double
Remarks

This property is effectively a shortcut to the Width/Height of the ActualWindowRect property.

ActualWorldRect

Gets the actual value of the WorldRect.

Declaration
public Rect ActualWorldRect { get; set; }
Property Value
Type Description
Rect

BackgroundContent

A UIElement to display behind all series, inside the viewport of the IgbGeographicMap control.

Declaration
public IgbGeographicMapImagery BackgroundContent { get; set; }
Property Value
Type Description
IgbGeographicMapImagery

BackgroundTilingMode

Gets or sets if the map should horizontally wrap.

Declaration
public MapBackgroundTilingMode BackgroundTilingMode { get; set; }
Property Value
Type Description
MapBackgroundTilingMode

ImageTilesReady

Declaration
public Action<IgbImageTilesReadyEventArgs> ImageTilesReady { get; set; }
Property Value
Type Description
System.Action<IgbImageTilesReadyEventArgs>

ImageTilesReadyScript

Declaration
public string ImageTilesReadyScript { get; set; }
Property Value
Type Description
System.String

IsHorizontalWrappingEnabled

Gets or sets if the map should horizontally wrap.

Declaration
public bool IsHorizontalWrappingEnabled { get; set; }
Property Value
Type Description
System.Boolean

NeedsDynamicContent

Declaration
protected override bool NeedsDynamicContent { get; }
Property Value
Type Description
System.Boolean
Overrides

ResizeBehavior

Gets or sets the behavior to use during resize.

Declaration
public MapResizeBehavior ResizeBehavior { get; set; }
Property Value
Type Description
MapResizeBehavior

SuppressZoomResetOnWorldRectChange

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

Declaration
public bool SuppressZoomResetOnWorldRectChange { get; set; }
Property Value
Type Description
System.Boolean

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseWorldRectForZoomBounds

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

Declaration
public bool UseWorldRectForZoomBounds { get; set; }
Property Value
Type Description
System.Boolean

WindowScale

A number between 0 and 1 determining the scale of the horizontal/vertical zoom.

Declaration
public double WindowScale { get; set; }
Property Value
Type Description
System.Double
Remarks

This property is effectively a shortcut to the Width/Height of the WindowRect property.

WorldRect

Gets or sets the world bounding rectangle.

Declaration
public Rect WorldRect { get; set; }
Property Value
Type Description
Rect

Zoomable

Gets or sets zoomability of the current control

Declaration
public bool Zoomable { get; set; }
Property Value
Type Description
System.Boolean

Methods

ClearTileCache()

Declaration
public void ClearTileCache()

ClearTileCacheAsync()

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

Declaration
public Task ClearTileCacheAsync()
Returns
Type Description
System.Threading.Tasks.Task

ConvertGeographicToZoom(Rect, Double)

Declaration
public Rect ConvertGeographicToZoom(Rect geographic, double extraPixelPadding)
Parameters
Type Name Description
Rect geographic
System.Double extraPixelPadding
Returns
Type Description
Rect

ConvertGeographicToZoomAsync(Rect, Double)

Declaration
public Task<Rect> ConvertGeographicToZoomAsync(Rect geographic, double extraPixelPadding)
Parameters
Type Name Description
Rect geographic
System.Double extraPixelPadding
Returns
Type Description
System.Threading.Tasks.Task<Rect>

DeferredRefresh()

Declaration
public void DeferredRefresh()

DeferredRefreshAsync()

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

Declaration
public Task DeferredRefreshAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

ExportVisualData()

Declaration
public object ExportVisualData()
Returns
Type Description
System.Object

ExportVisualDataAsync()

Returns the chart visuals expressed as a ChartVisualData object.

Declaration
public Task<object> ExportVisualDataAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetActualWindowScaleHorizontal()

Declaration
public override double GetActualWindowScaleHorizontal()
Returns
Type Description
System.Double
Overrides

GetActualWindowScaleHorizontalAsync()

Gets actual window scale for horizontal dimension of the control

Declaration
public override Task<double> GetActualWindowScaleHorizontalAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

GetActualWindowScaleVertical()

Declaration
public override double GetActualWindowScaleVertical()
Returns
Type Description
System.Double
Overrides

GetActualWindowScaleVerticalAsync()

Gets actual window scale for vertical dimension of the control

Declaration
public override Task<double> GetActualWindowScaleVerticalAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

GetCurrentActualWorldRect()

Declaration
public Rect GetCurrentActualWorldRect()
Returns
Type Description
Rect

GetCurrentActualWorldRectAsync()

Gets current world rect in geographic coordinates

Declaration
public Task<Rect> GetCurrentActualWorldRectAsync()
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetGeographicFromZoom(Rect)

Declaration
public Rect GetGeographicFromZoom(Rect windowRect)
Parameters
Type Name Description
Rect windowRect
Returns
Type Description
Rect

GetGeographicFromZoomAsync(Rect)

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

Declaration
public Task<Rect> GetGeographicFromZoomAsync(Rect windowRect)
Parameters
Type Name Description
Rect windowRect

The zoom area.
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetGeographicPoint(Point)

Declaration
public Point GetGeographicPoint(Point pixelCoordinate)
Parameters
Type Name Description
Point pixelCoordinate
Returns
Type Description
Point

GetGeographicPointAsync(Point)

Convert a pixel-based coordinate to a geographic coordinate.

Declaration
public Task<Point> GetGeographicPointAsync(Point pixelCoordinate)
Parameters
Type Name Description
Point pixelCoordinate

A pixel-based coordinate
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetPixelPoint(Point)

Declaration
public Point GetPixelPoint(Point geographicCoordinate)
Parameters
Type Name Description
Point geographicCoordinate
Returns
Type Description
Point

GetPixelPointAsync(Point)

Convert a geographic coordinate to a pixel-based coordinate.

Declaration
public Task<Point> GetPixelPointAsync(Point geographicCoordinate)
Parameters
Type Name Description
Point geographicCoordinate

A geographic coordinate
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetWindowPoint(Point)

Declaration
public Point GetWindowPoint(Point geographicCoordinate)
Parameters
Type Name Description
Point geographicCoordinate
Returns
Type Description
Point

GetWindowPointAsync(Point)

Convert a geographic coordinate to a pixel-based coordinate.

Declaration
public Task<Point> GetWindowPointAsync(Point geographicCoordinate)
Parameters
Type Name Description
Point geographicCoordinate

A geographic coordinate
Returns
Type Description
System.Threading.Tasks.Task<Point>

GetZoomFromGeographicPoints(Point, Point)

Declaration
public Rect GetZoomFromGeographicPoints(Point northWest, Point southEast)
Parameters
Type Name Description
Point northWest
Point southEast
Returns
Type Description
Rect

GetZoomFromGeographicPointsAsync(Point, Point)

Declaration
public Task<Rect> GetZoomFromGeographicPointsAsync(Point northWest, Point southEast)
Parameters
Type Name Description
Point northWest
Point southEast
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetZoomFromGeographicRect(Rect)

Declaration
public Rect GetZoomFromGeographicRect(Rect geographic)
Parameters
Type Name Description
Rect geographic
Returns
Type Description
Rect

GetZoomFromGeographicRectAsync(Rect)

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

Declaration
public Task<Rect> GetZoomFromGeographicRectAsync(Rect geographic)
Parameters
Type Name Description
Rect geographic

The geographic area.
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetZoomRectFromGeoRect(Rect)

Declaration
public Rect GetZoomRectFromGeoRect(Rect geographic)
Parameters
Type Name Description
Rect geographic
Returns
Type Description
Rect

GetZoomRectFromGeoRectAsync(Rect)

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

Declaration
public Task<Rect> GetZoomRectFromGeoRectAsync(Rect geographic)
Parameters
Type Name Description
Rect geographic

The geographic area.
Returns
Type Description
System.Threading.Tasks.Task<Rect>

StyleUpdated()

Declaration
public void StyleUpdated()

StyleUpdatedAsync()

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

Declaration
public Task StyleUpdatedAsync()
Returns
Type Description
System.Threading.Tasks.Task

UpdateWorldRect(Rect)

Declaration
public void UpdateWorldRect(Rect worldRect)
Parameters
Type Name Description
Rect worldRect

UpdateWorldRectAsync(Rect)

Updates world rect in geographic coordinates

Declaration
public Task UpdateWorldRectAsync(Rect worldRect)
Parameters
Type Name Description
Rect worldRect
Returns
Type Description
System.Threading.Tasks.Task

UpdateZoomWindow(Rect)

Declaration
public void UpdateZoomWindow(Rect zoomWindow)
Parameters
Type Name Description
Rect zoomWindow

UpdateZoomWindowAsync(Rect)

Updates zoom window using window coordinates

Declaration
public Task UpdateZoomWindowAsync(Rect zoomWindow)
Parameters
Type Name Description
Rect zoomWindow
Returns
Type Description
System.Threading.Tasks.Task

ZoomToGeographic(Rect)

Declaration
public void ZoomToGeographic(Rect geographic)
Parameters
Type Name Description
Rect geographic

ZoomToGeographicAsync(Rect)

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

Declaration
public Task ZoomToGeographicAsync(Rect geographic)
Parameters
Type Name Description
Rect geographic

The geographic region to zoom to.
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable