ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
This is an old revision of the document!
This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl.
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | Constructor of AdornmentOverlay class. |
Name | Parameters | DeclaringType | Summary |
---|
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | Overlay | ||
![]() | Overlay | This method dispose unmanaged resource used in this class. | |
![]() | RectangleShape | Overlay | This method draws the overlay with the provided extent in world coordinate. |
![]() | RectangleShape, OverlayRefreshType | Overlay | This method draws the overlay with the provided extent in world coordinate. |
![]() | Object | Object | |
![]() | Overlay | This method gets a bounding box of the Overlay. | |
![]() | Object | ||
![]() | Object | ||
![]() | MapArguments | Overlay | This method initializes overlay object. |
![]() | Byte[] | Overlay | This method restore the overlay state back from the specified state. |
![]() | Overlay | ||
![]() | RectangleShape | Overlay | This method pans the overlay to the provided world extent. |
![]() | IEnumerable<RectangleShape> | Overlay | |
![]() | TimeSpan | Overlay | |
![]() | TimeSpan, RequestDrawingBufferTimeType | Overlay | |
![]() | RectangleShape, TimeSpan | Overlay | |
![]() | IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType | Overlay | |
![]() | RectangleShape | Overlay | |
![]() | IEnumerable<RectangleShape>, TimeSpan | Overlay | |
![]() | Overlay | 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. | |
![]() | RectangleShape, TimeSpan, RequestDrawingBufferTimeType | Overlay | |
![]() | Overlay | This method saves overlay state to a byte array. | |
![]() | Object |
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | Overlay | ||
![]() | Boolean | Overlay(overriden) | This method disposes the unmanaged resource used in this overlay. |
![]() | GeoCanvas | Overlay | |
![]() | RectangleShape, OverlayRefreshType | Overlay(overriden) | This method override the DrawCore logic of the Overlay class. |
![]() | Object(overriden) | ||
![]() | Overlay | This method returns the bounding box of the Overlay. | |
![]() | MapArguments | Overlay | This method initializes overlay object. |
![]() | Byte[] | Overlay(overriden) | This method restore the overlay state back from the specified state. |
![]() | Object | ||
![]() | DrawingOverlayEventArgs | Overlay | This method raises before the overlay is drawing. |
![]() | DrawingAttributionOverlayEventArgs | Overlay | |
![]() | DrawnOverlayEventArgs | Overlay | This method raises after the overlay is drawn. |
![]() | DrawnAttributionOverlayEventArgs | Overlay | |
![]() | Overlay | ||
![]() | RectangleShape | Overlay | This method pans the overlay to the provided world extent. |
![]() | Overlay | 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. | |
![]() | RectangleShape | Overlay | |
![]() | Overlay(overriden) | This method saves overlay state to a byte array. |
Name | Return | DeclaringType | Summary |
---|---|---|---|
![]() | String | Overlay | |
![]() | TimeSpan | Overlay | |
![]() | Boolean | Overlay | |
![]() | DrawingExceptionMode | Overlay | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. |
![]() | Boolean | Overlay | |
![]() | Boolean | ||
![]() | Boolean | Overlay | Gets or sets if this overlay is visible. |
![]() | GeoCollection<AdornmentLayer> | This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. | |
![]() | MapArguments | Overlay | Gets or sets current map information which will be used for calculating mechanism. |
![]() | String | Overlay | Gets or sets the name of this overaly. |
![]() | Canvas | Overlay | Gets or sets the actual canvas which maintains all the visual elements on the overlay. |
![]() | Boolean | This property is a easy way to add the LogoAdornmentLayer to the AdormentOverlay. |
Name | Return | DeclaringType | Summary |
---|---|---|---|
![]() | Boolean | Overlay | Gets or sets if the overlay canvas is initialized. |
![]() | RectangleShape | Overlay | Gets or sets the previous exent of the overlay. |
Name | Event Arguments | DeclaringType | Summary |
---|---|---|---|
![]() | DrawingOverlayEventArgs | Overlay | This event raises before the overlay is drawing. |
![]() | DrawingAttributionOverlayEventArgs | Overlay | |
![]() | DrawnOverlayEventArgs | Overlay | This event raises after the overlay is drawn. |
![]() | DrawnAttributionOverlayEventArgs | Overlay |
Constructor of AdornmentOverlay class.
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#AdornmentOverlay.28.29
Name | Type | Description |
---|
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Close.28.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|
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.AdornmentOverlay#Dispose.28.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|
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.AdornmentOverlay#Draw.28RectangleShape.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
targetExtent | RectangleShape | This parameter indicates an extent in world coordinate for drawing the overlay. |
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.AdornmentOverlay#Draw.28RectangleShape.2C_OverlayRefreshType.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
targetExtent | RectangleShape | This parameter indicates an extent in world coordinate for drawing the overlay. |
refreshType | OverlayRefreshType | 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. |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Equals.28Object.29
Return Type | Description |
---|---|
Boolean |
Name | Type | Description |
---|---|---|
obj | Object |
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.
Return Type | Description |
---|---|
RectangleShape | A RectangleShape indicating the bounding box of this overlay |
Name | Type | Description |
---|
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#GetHashCode.28.29
Return Type | Description |
---|---|
Int32 |
Name | Type | Description |
---|
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#GetType.28.29
Return Type | Description |
---|---|
Type |
Name | Type | Description |
---|
This method initializes overlay object.
This is a wrapper method for the virtual method InitializeCore.
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
mapArguments | MapArguments | This parameter maintains current map information for calculating mechanism. |
This method restore the overlay state back from the specified state.
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
state | Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay –> | This parameter indicates the state for restore the overlay. |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Open.28.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|
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.
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
targetExtent | RectangleShape | This parameter is the target world extent for panning. |
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
extentsToRefresh | IEnumerable<RectangleShape> |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Refresh.28TimeSpan.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
bufferTime | TimeSpan |
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
bufferTime | TimeSpan | |
bufferTimeType | RequestDrawingBufferTimeType |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Refresh.28RectangleShape.2C_TimeSpan.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
extentToRefresh | RectangleShape | |
bufferTime | TimeSpan |
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
extentsToRefresh | IEnumerable<RectangleShape> | |
bufferTime | TimeSpan | |
bufferTimeType | RequestDrawingBufferTimeType |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Refresh.28RectangleShape.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
extent | RectangleShape |
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
extentsToRefresh | IEnumerable<RectangleShape> | |
bufferTime | TimeSpan |
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.
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
extentToRefresh | RectangleShape | |
bufferTime | TimeSpan | |
bufferTimeType | RequestDrawingBufferTimeType |
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.AdornmentOverlay#SaveState.28.29
Return Type | Description |
---|---|
Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay –> | A byte array indicates current overlay state. |
Name | Type | Description |
---|
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#ToString.28.29
Return Type | Description |
---|---|
String |
Name | Type | Description |
---|
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#CloseCore.28.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|
This method disposes the unmanaged resource used in this overlay.
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Dispose.28Boolean.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
disposing | Boolean |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawAttributionCore.28GeoCanvas.29
Return Type | Description |
---|---|
Void |
This method override the DrawCore logic of the Overlay class.
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawCore.28RectangleShape.2C_OverlayRefreshType.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
targetExtent | RectangleShape | This parameter specifies the extent for drawing this overlay. |
overlayRefreshType | OverlayRefreshType | This parameter specifies whether this overlay need to be clear and refresh or not. |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Finalize.28.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|
This method returns the bounding box of the Overlay.
This method returns the bounding box of the Overlay.
Return Type | Description |
---|---|
RectangleShape | This method returns the bounding box of the Overlay. |
Name | Type | Description |
---|
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.
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
mapArguments | MapArguments | This parameter maintains current map information for calculating mechanism. |
This method restore the overlay state back from the specified state.
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
state | Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay –> | This parameter indicates the state for restore the overlay. |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#MemberwiseClone.28.29
Return Type | Description |
---|---|
Object |
Name | Type | Description |
---|
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.AdornmentOverlay#OnDrawing.28DrawingOverlayEventArgs.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
e | DrawingOverlayEventArgs | This parameter is the event argument for Drawing event. |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
args | DrawingAttributionOverlayEventArgs |
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.AdornmentOverlay#OnDrawn.28DrawnOverlayEventArgs.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
e | DrawnOverlayEventArgs | This parameter is the event argument for Drawn event. |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
args | DrawnAttributionOverlayEventArgs |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OpenCore.28.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|
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.
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
targetExtent | RectangleShape | This parameter is the target world extent for panning. |
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.
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#RefreshCore.28RectangleShape.29
Return Type | Description |
---|---|
Void |
Name | Type | Description |
---|---|---|
extent | RectangleShape |
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.AdornmentOverlay#SaveStateCore.28.29
Return Type | Description |
---|---|
Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay –> | A byte array indicates current overlay state. |
Name | Type | Description |
---|
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawAttributionCore.28GeoCanvas.29
Return Type |
---|
String |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#AutoRefreshInterval
Return Type |
---|
TimeSpan |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#CanRefreshRegion
Return Type |
---|
Boolean |
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.AdornmentOverlay#DrawingExceptionMode
Return Type |
---|
DrawingExceptionMode |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsBase
Return Type |
---|
Boolean |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsEmpty
Return Type |
---|
Boolean |
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.AdornmentOverlay#IsVisible
Return Type |
---|
Boolean |
This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Layers
Return Type |
---|
GeoCollection<AdornmentLayer> |
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.AdornmentOverlay#Initialize.28MapArguments.29
Return Type |
---|
MapArguments |
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.AdornmentOverlay#Name
Return Type |
---|
String |
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.AdornmentOverlay#OverlayCanvas
Return Type |
---|
Canvas |
This property is a easy way to add the LogoAdornmentLayer to the AdormentOverlay.
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#ShowLogo
Return Type |
---|
Boolean |
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.AdornmentOverlay#IsOverlayInitialized
Return Type |
---|
Boolean |
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.AdornmentOverlay#PreviousExtent
Return Type |
---|
RectangleShape |
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.AdornmentOverlay#OnDrawing.28DrawingOverlayEventArgs.29
Event Arguments |
---|
DrawingOverlayEventArgs |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29
Event Arguments |
---|
DrawingAttributionOverlayEventArgs |
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.AdornmentOverlay#OnDrawn.28DrawnOverlayEventArgs.29
Event Arguments |
---|
DrawnOverlayEventArgs |
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29