Table of Contents

ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay
- Inheritance Hierarchy
- Members Summary

ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

This class represents an overlay to place popups on the map.

Inheritance Hierarchy

System.Object
- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay
  - ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay

Members Summary

Public Constructors

PopupOverlay()

This is constructor of PopupOverlay class.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#PopupOverlay.28.29

Parameters

PopupOverlay(IEnumerable<Popup>)

This is constructor of PopupOverlay class.

Remarks

For the most updated Info for this topic, please check it here:

Parameters

popups
- Type:IEnumerable<Popup>
- Description:This parameter indicates a collection of popup that are added into this overlay.

Protected Constructors

Public Methods

Refresh(IEnumerable<RectangleShape>)

N/A

Remarks

For the most updated Info for this topic, please check it here:

Return Value

Type:Void
Description:N/A

Parameters

extentsToRefresh
- Type:IEnumerable<RectangleShape>
- Description:N/A

Refresh(TimeSpan)

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Refresh.28TimeSpan.29

Return Value

Type:Void
Description:N/A

Parameters

bufferTime
- Type:TimeSpan
- Description:N/A

Refresh(TimeSpan,RequestDrawingBufferTimeType)

N/A

Remarks

For the most updated Info for this topic, please check it here:

Return Value

Type:Void
Description:N/A

Parameters

bufferTime
- Type:TimeSpan
- Description:N/A

bufferTimeType
- Type:RequestDrawingBufferTimeType
- Description:N/A

Refresh(RectangleShape,TimeSpan)

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Refresh.28RectangleShape.2C_TimeSpan.29

Return Value

Type:Void
Description:N/A

Parameters

extentToRefresh
- Type:RectangleShape
- Description:N/A

bufferTime
- Type:TimeSpan
- Description:N/A

Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

N/A

Remarks

For the most updated Info for this topic, please check it here:

Return Value

Type:Void
Description:N/A

Parameters

extentToRefresh
- Type:RectangleShape
- Description:N/A

bufferTime
- Type:TimeSpan
- Description:N/A

bufferTimeType
- Type:RequestDrawingBufferTimeType
- Description:N/A

Refresh(IEnumerable<RectangleShape>,TimeSpan)

N/A

Remarks

For the most updated Info for this topic, please check it here:

Return Value

Type:Void
Description:N/A

Parameters

extentsToRefresh
- Type:IEnumerable<RectangleShape>
- Description:N/A

bufferTime
- Type:TimeSpan
- Description:N/A

Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

N/A

Remarks

For the most updated Info for this topic, please check it here:

Return Value

Type:Void
Description:N/A

Parameters

extentsToRefresh
- Type:IEnumerable<RectangleShape>
- Description:N/A

bufferTime
- Type:TimeSpan
- Description:N/A

bufferTimeType
- Type:RequestDrawingBufferTimeType
- Description:N/A

Initialize(MapArguments)

This method initializes overlay object.

Remarks

This is a wrapper method for the virtual method InitializeCore.

Return Value

Type:Void
Description:N/A

Parameters

mapArguments
- Type:MapArguments
- Description:This parameter maintains current map information for calculating mechanism.

Refresh(RectangleShape)

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Refresh.28RectangleShape.29

Return Value

Type:Void
Description:N/A

Parameters

extent
- Type:RectangleShape
- Description:N/A

Refresh()

This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.

Remarks

The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.

Return Value

Type:Void
Description:N/A

Parameters

Close()

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Close.28.29

Return Value

Type:Void
Description:N/A

Parameters

Open()

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Open.28.29

Return Value

Type:Void
Description:N/A

Parameters

Draw(RectangleShape)

This method draws the overlay with the provided extent in world coordinate.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Draw.28RectangleShape.29

Return Value

Type:Void
Description:N/A

Parameters

targetExtent
- Type:RectangleShape
- Description:This parameter indicates an extent in world coordinate for drawing the overlay.

Draw(RectangleShape,OverlayRefreshType)

This method draws the overlay with the provided extent in world coordinate.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Draw.28RectangleShape.2C_OverlayRefreshType.29

Return Value

Type:Void
Description:N/A

Parameters

targetExtent
- Type:RectangleShape
- Description:This parameter indicates an extent in world coordinate for drawing the overlay.

refreshType
- Type:OverlayRefreshType
- Description:This parameter indicates whether the elements of this overlay needs to be refreshed. For example, TileOverlay is formed by tiles. When panning the map around, the existing tile doesn't need to be redraw, the only thing we need to do is modifying the position of these tiles. On another hand, when click to change the style of the overlay, we need to redraw the tile images to change the appearance. So we need refresh mode.

PanTo(RectangleShape)

This method pans the overlay to the provided world extent.

Remarks

Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.

Return Value

Type:Void
Description:N/A

Parameters

targetExtent
- Type:RectangleShape
- Description:This parameter is the target world extent for panning.

GetBoundingBox()

This method gets a bounding box of the Overlay.

Remarks

This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the Overlay. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

Return Value

Type:RectangleShape
Description:A RectangleShape indicating the bounding box of this overlay

Parameters

SaveState()

This method saves overlay state to a byte array.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#SaveState.28.29

Return Value

Type:Byte[]
Description:A byte array indicates current overlay state.

Parameters

LoadState(Byte[])

This method restore the overlay state back from the specified state.

Remarks

For the most updated Info for this topic, please check it here:

Return Value

Type:Void
Description:N/A

Parameters

state
- Type:Byte[]
- Description:This parameter indicates the state for restore the overlay.

Dispose()

This method dispose unmanaged resource used in this class.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Dispose.28.29

Return Value

Type:Void
Description:N/A

Parameters

ToString()

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#ToString.28.29

Return Value

Type:String
Description:N/A

Parameters

Equals(Object)

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Equals.28Object.29

Return Value

Type:Boolean
Description:N/A

Parameters

obj
- Type:Object
- Description:N/A

GetHashCode()

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#GetHashCode.28.29

Return Value

Type:Int32
Description:N/A

Parameters

GetType()

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#GetType.28.29

Return Value

Type:Type
Description:N/A

Parameters

Protected Methods

GetBoundingBoxCore()

This method returns a bounding box to hold all popups.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#GetBoundingBoxCore.28.29

Return Value

Type:RectangleShape
Description:A RectangleShape value that to hold all popups.

Parameters

DrawCore(RectangleShape,OverlayRefreshType)

This method draws the popups by the specified targetExtent.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#DrawCore.28RectangleShape.2C_OverlayRefreshType.29

Return Value

Type:Void
Description:N/A

Parameters

targetExtent
- Type:RectangleShape
- Description:This parameter indicates an extent to draw the popups.

overlayRefreshType
- Type:OverlayRefreshType
- Description:This parameter indicates whether this overlay needs to be refresh or not.

InitializeCore(MapArguments)

This method initializes overlay object.

Remarks

When implementing this method, consider initializing the overlay canvas such as setting its z-index, setting current map reference to the CurrentMap property.

Return Value

Type:Void
Description:N/A

Parameters

mapArguments
- Type:MapArguments
- Description:This parameter maintains current map information for calculating mechanism.

RefreshCore(RectangleShape)

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#RefreshCore.28RectangleShape.29

Return Value

Type:Void
Description:N/A

Parameters

extent
- Type:RectangleShape
- Description:N/A

RefreshCore()

This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.

Remarks

The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.

Return Value

Type:Void
Description:N/A

Parameters

CloseCore()

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#CloseCore.28.29

Return Value

Type:Void
Description:N/A

Parameters

OpenCore()

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OpenCore.28.29

Return Value

Type:Void
Description:N/A

Parameters

4hM=(GeoCanvas)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

canvas
- Type:GeoCanvas
- Description:N/A

DrawAttributionCore(GeoCanvas)

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#DrawAttributionCore.28GeoCanvas.29

Return Value

Type:Void
Description:N/A

Parameters

canvas
- Type:GeoCanvas
- Description:N/A

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29

Return Value

Type:Void
Description:N/A

Parameters

args
- Type:DrawingAttributionOverlayEventArgs
- Description:N/A

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29

Return Value

Type:Void
Description:N/A

Parameters

args
- Type:DrawnAttributionOverlayEventArgs
- Description:N/A

PanToCore(RectangleShape)

This method pans the overlay to the provided world extent.

Remarks

Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.

Return Value

Type:Void
Description:N/A

Parameters

targetExtent
- Type:RectangleShape
- Description:This parameter is the target world extent for panning.

OnDrawing(DrawingOverlayEventArgs)

This method raises before the overlay is drawing.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawing.28DrawingOverlayEventArgs.29

Return Value

Type:Void
Description:N/A

Parameters

e
- Type:DrawingOverlayEventArgs
- Description:This parameter is the event argument for Drawing event.

OnDrawn(DrawnOverlayEventArgs)

This method raises after the overlay is drawn.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawn.28DrawnOverlayEventArgs.29

Return Value

Type:Void
Description:N/A

Parameters

e
- Type:DrawnOverlayEventArgs
- Description:This parameter is the event argument for Drawn event.

SaveStateCore()

This method saves overlay state to a byte array.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#SaveStateCore.28.29

Return Value

Type:Byte[]
Description:A byte array indicates current overlay state.

Parameters

LoadStateCore(Byte[])

This method restore the overlay state back from the specified state.

Remarks

For the most updated Info for this topic, please check it here:

Return Value

Type:Void
Description:N/A

Parameters

state
- Type:Byte[]
- Description:This parameter indicates the state for restore the overlay.

Finalize()

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Finalize.28.29

Return Value

Type:Void
Description:N/A

Parameters

Dispose(Boolean)

This method dispose unmanaged resource used in this class.

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Dispose.28Boolean.29

Return Value

Type:Void
Description:N/A

Parameters

disposing
- Type:Boolean
- Description:N/A

OnRefreshing(OverlayRefreshType)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

refreshType
- Type:OverlayRefreshType
- Description:N/A

MemberwiseClone()

N/A

Remarks

For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#MemberwiseClone.28.29

Return Value

Type:Object
Description:N/A

Parameters

Public Properties

Popups

This property gets a collection of popup that are added into this overlay.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Popups

Return Value

Type:ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.WpfDesktopEdition.Popup, WpfDesktopEdition, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null|GeoCollection<T>]]

AutoRefreshInterval

N/A

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#AutoRefreshInterval

Return Value

Type:TimeSpan

Name

Gets or sets the name of this overaly.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Name

Return Value

Type:String

MapArguments

Gets or sets current map information which will be used for calculating mechanism.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Initialize.28MapArguments.29

Return Value

Type:MapArguments

OverlayCanvas

Gets or sets the actual canvas which maintains all the visual elements on the overlay.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OverlayCanvas

Return Value

Type:Canvas

IsBase

N/A

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#IsBase

Return Value

Type:Boolean

CanRefreshRegion

N/A

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#CanRefreshRegion

Return Value

Type:Boolean

DrawingExceptionMode

This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#DrawingExceptionMode

Return Value

Type:DrawingExceptionMode

IsVisible

Gets or sets if this overlay is visible.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#IsVisible

Return Value

Type:Boolean

Attribution

N/A

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#DrawAttributionCore.28GeoCanvas.29

Return Value

Type:String

IsEmpty

This property gets if this overlay is empty or not.

Remarks

This property enhances the performance of the overlay while drawing. If is true, we will skip drawing this overlay and continue drawing the next overlay.

Return Value

Type:Boolean

Protected Properties

PreviousExtent

Gets or sets the previous exent of the overlay.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#PreviousExtent

Return Value

Type:RectangleShape

3BM=

N/A

Remarks

N/A

Return Value

Type:Double

IsOverlayInitialized

Gets or sets if the overlay canvas is initialized.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#IsOverlayInitialized

Return Value

Type:Boolean

Public Events

Drawing This event raises before the overlay is drawing.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawing.28DrawingOverlayEventArgs.29

Event Arguments:DrawingOverlayEventArgs

Drawn This event raises after the overlay is drawn.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawn.28DrawnOverlayEventArgs.29

Event Arguments:DrawnOverlayEventArgs

DrawingAttribution N/A

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29

Event Arguments:DrawingAttributionOverlayEventArgs

DrawnAttribution N/A

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29

Event Arguments:DrawnAttributionOverlayEventArgs