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

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

PopupOverlay()

• This is constructor of PopupOverlay class.

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

PopupOverlay(IEnumerable<Popup>)

• This is constructor of PopupOverlay class.

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

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

Refresh(IEnumerable<RectangleShape>)

• N/A

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

• Type:Void
• Description:N/A

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

Refresh(TimeSpan)

• N/A

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

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

Refresh(TimeSpan,RequestDrawingBufferTimeType)

• N/A

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

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

Refresh(RectangleShape,TimeSpan)

• N/A

• 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

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

• N/A

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

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

Refresh(IEnumerable<RectangleShape>,TimeSpan)

• N/A

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

• Type:Void
• Description:N/A

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

• bufferTime
  • Type:TimeSpan
  • Description:N/A

Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

• N/A

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

• Type:Void
• Description:N/A

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

• This is a wrapper method for the virtual method InitializeCore.

• Type:Void
• Description:N/A

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

Refresh(RectangleShape)

• N/A

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

• Type:Void
• Description:N/A

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

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

• Type:Void
• Description:N/A

Close()

• N/A

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

• Type:Void
• Description:N/A

Open()

• N/A

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

• Type:Void
• Description:N/A

Draw(RectangleShape)

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

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

• Type:Void
• Description:N/A

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

• 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

• Type:Void
• Description:N/A

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

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

• Type:Void
• Description:N/A

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

GetBoundingBox()

• This method gets a bounding box of the Overlay.

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

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

SaveState()

• This method saves overlay state to a byte array.

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

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

LoadState(Byte[])

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

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

• Type:Void
• Description:N/A

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

Dispose()

• This method dispose unmanaged resource used in this class.

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

• Type:Void
• Description:N/A

ToString()

• N/A

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

• Type:String
• Description:N/A

Equals(Object)

• N/A

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

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

• N/A

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

• Type:Int32
• Description:N/A

GetType()

• N/A

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

• Type:Type
• Description:N/A

GetBoundingBoxCore()

• This method returns a bounding box to hold all popups.

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

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

DrawCore(RectangleShape,OverlayRefreshType)

• This method draws the popups by the specified targetExtent.

• 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

• Type:Void
• Description:N/A

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

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

• Type:Void
• Description:N/A

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

RefreshCore(RectangleShape)

• N/A

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

• Type:Void
• Description:N/A

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

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

• Type:Void
• Description:N/A

CloseCore()

• N/A

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

• Type:Void
• Description:N/A

OpenCore()

• N/A

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

• Type:Void
• Description:N/A

4hM=(GeoCanvas)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

DrawAttributionCore(GeoCanvas)

• N/A

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

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

• N/A

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

• Type:Void
• Description:N/A

• args
  • Type:DrawingAttributionOverlayEventArgs
  • Description:N/A

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

• N/A

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

• Type:Void
• Description:N/A

• args
  • Type:DrawnAttributionOverlayEventArgs
  • Description:N/A

PanToCore(RectangleShape)

• This method pans the overlay to the provided world extent.

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

• Type:Void
• Description:N/A

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

OnDrawing(DrawingOverlayEventArgs)

• This method raises before the overlay is drawing.

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

• Type:Void
• Description:N/A

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

OnDrawn(DrawnOverlayEventArgs)

• This method raises after the overlay is drawn.

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

• Type:Void
• Description:N/A

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

SaveStateCore()

• This method saves overlay state to a byte array.

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

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

LoadStateCore(Byte[])

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

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

• Type:Void
• Description:N/A

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

Finalize()

• N/A

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

• Type:Void
• Description:N/A

Dispose(Boolean)

• This method dispose unmanaged resource used in this class.

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

• Type:Void
• Description:N/A

• disposing
  • Type:Boolean
  • Description:N/A

OnRefreshing(OverlayRefreshType)

• N/A

• N/A

• Type:Void
• Description:N/A

• refreshType
  • Type:OverlayRefreshType
  • Description:N/A

MemberwiseClone()

• N/A

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

• Type:Object
• Description:N/A

Popups

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

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

• 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

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

• Type:TimeSpan

Name

Gets or sets the name of this overaly.

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

• Type:String

MapArguments

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

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

• Type:MapArguments

OverlayCanvas

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

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

• Type:Canvas

IsBase

N/A

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

• Type:Boolean

CanRefreshRegion

N/A

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

• Type:Boolean

DrawingExceptionMode

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

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

• Type:DrawingExceptionMode

IsVisible

Gets or sets if this overlay is visible.

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

• Type:Boolean

Attribution

N/A

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

• Type:String

IsEmpty

This property gets if this overlay is empty or not.

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.

• Type:Boolean

PreviousExtent

Gets or sets the previous exent of the overlay.

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

• Type:RectangleShape

3BM=

N/A

N/A

• Type:Double

IsOverlayInitialized

Gets or sets if the overlay canvas is initialized.

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

• Type:Boolean

Drawing This event raises before the overlay is drawing.

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.

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

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

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