User Tools

Site Tools


12.0:apis:thinkgeo.ui.wpf.overlay

ThinkGeo.UI.Wpf.Overlay

Inheritance Hierarchy

Members Summary

Public Constructors

Protected Constructors

Overlay()

  • Constructor of the Overlay class.
Remarks
  • N/A
Parameters

Public Methods

Initialize(MapArguments)

  • N/A
Remarks
  • This is a wrapper method for the virtual method InitializeCore.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • mapArguments
    • Description:This parameter maintains current map information for calculating mechanism.

Refresh(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Refresh()

  • N/A
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
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Open()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Draw(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • targetExtent
    • Description:This parameter indicates an extent in world coordinate for drawing the overlay.

Draw(RectangleShape,OverlayRefreshType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • targetExtent
    • Description:This parameter indicates an extent in world coordinate for drawing the overlay.
  • refreshType
    • 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)

  • N/A
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
    • Description:This parameter is the target world extent for panning.

GetBoundingBox()

  • N/A
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
  • Description:A RectangleShape indicating the bounding box of this overlay
Parameters

SaveState()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Byte[]
  • Description:A byte array indicates current overlay state.
Parameters

LoadState(Byte[])

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • state
    • Type:Byte[]
    • Description:This parameter indicates the state for restore the overlay.

Dispose()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Refresh(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Refresh(TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

Refresh(TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

Refresh(RectangleShape,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

Refresh(IEnumerable<RectangleShape>,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

Protected Methods

InitializeCore(MapArguments)

  • N/A
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
    • Description:This parameter maintains current map information for calculating mechanism.

RefreshCore(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RefreshCore()

  • N/A
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
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OpenCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawCore(RectangleShape,OverlayRefreshType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • targetExtent
    • Description:This parameter indicates an extent in world coordinate for drawing the overlay.
  • overlayRefreshType
    • Description:This parameter indicates whether the elements of this overlay needs to be refreshed. For example, TileOverlay is formed by tiles. When panning or zooming the map, the existing tile doesn't need to be redraw, because the styles are the same as the previous states. 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.

DrawAttribution(GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawAttributionCore(GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

PanToCore(RectangleShape)

  • N/A
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
    • Description:This parameter is the target world extent for panning.

OnDrawing(DrawingOverlayEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawn(DrawnOverlayEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetBoundingBoxCore()

  • N/A
Remarks
  • This method returns the bounding box of the Overlay.
Return Value
  • Description:This method returns the bounding box of the Overlay.
Parameters

SaveStateCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Byte[]
  • Description:A byte array indicates current overlay state.
Parameters

LoadStateCore(Byte[])

  • N/A
Remarks
  • N/A
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
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Dispose(Boolean)

  • N/A
Remarks
  • N/A
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

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

Name

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

MapArguments

  • N/A
Remarks
  • N/A
Return Value

OverlayCanvas

  • N/A
Remarks
  • N/A
Return Value
  • Type:Canvas

IsBase

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

CanRefreshRegion

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

DrawingExceptionMode

  • N/A
Remarks
  • N/A
Return Value

IsVisible

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Attribution

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

IsEmpty

  • N/A
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

AutoRefreshInterval

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

Protected Properties

PreviousExtent

  • N/A
Remarks
  • N/A
Return Value

PreviousScale

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double

IsOverlayInitialized

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Public Events

Drawing

  • N/A
Remarks
  • N/A

Event Arguments:DrawingOverlayEventArgs

Drawn

  • N/A
Remarks
  • N/A

Event Arguments:DrawnOverlayEventArgs

DrawingAttribution

  • N/A
Remarks
  • N/A

Event Arguments:DrawingAttributionOverlayEventArgs

DrawnAttribution

  • N/A
Remarks
  • N/A

Event Arguments:DrawnAttributionOverlayEventArgs

12.0/apis/thinkgeo.ui.wpf.overlay.txt · Last modified: 2019/09/26 09:44 (external edit)