ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.androidedition.adornmentoverlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.AndroidEdition.AdornmentOverlay
<!– Class –>
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.AndroidEdition.Overlay *ThinkGeo.MapSuite.AndroidEdition.AdornmentOverlay
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 AdornmentOverlay | Initializes a new instance of the class. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Close | Overlay | This method will simulate the Close interaction. | |
| Dispose | Overlay | This method dispose unmanaged resource used in this class. | |
| Draw | MapArguments, OverlayRefreshType | Overlay | This method draws the overlay with the provided extent in world coordinate. |
| Equals | Object | Object | |
| GetBoundingBox | Overlay | This method gets a bounding box of the Overlay. | |
| GetHashCode | Object | ||
| GetType | Object | ||
| Initialize | MapArguments | Overlay | This method initializes overlay object. |
| Open | Overlay | This method will simulate the Open interaction. | |
| PostTransform | TransformArguments, MapArguments | Overlay | This method will simulate the PostTransform interaction. |
| Refresh | 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. | |
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 CloseCore | Overlay | This protected virtual method is the Core method of Close API. | |
| Dispose | Boolean | Overlay(overriden) | Releases unmanaged and - optionally - managed resources. |
| DrawCore | MapArguments, OverlayRefreshType | Overlay(overriden) | This method draws the overlay with the provided extent in world coordinate. |
| DrawException | GeoCanvas, Exception | Overlay | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. |
| DrawExceptionCore | GeoCanvas, Exception | Overlay | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. |
| Finalize | Object(overriden) | ||
| GetBoundingBoxCore | Overlay | This method returns the bounding box of the Overlay. | |
| InitializeCore | MapArguments | Overlay(overriden) | This method initializes overlay object. |
| MemberwiseClone | Object | ||
| OnDrawingException | DrawingExceptionOverlayEventArgs | Overlay | This method raises before the overlay is drawing exception. |
| OnDrawnException | DrawnExceptionOverlayEventArgs | Overlay | This method raises after the overlay is drawn exception. |
| OpenCore | Overlay | This protected virtual method is the Core method of Open API. | |
| PostTransformCore | TransformArguments, MapArguments | Overlay | This protected virtual method is the Core method of PostTransform API. |
| RefreshCore | 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. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Attribution | String | Overlay | Gets or sets the attribution for this overlay. |
| DrawingExceptionMode | DrawingExceptionMode | Overlay | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. |
| DrawingQuality | DrawingQuality | Overlay | Gets or sets the drawingQuality for this overlay. |
| IsEmpty | Boolean | Overlay(overriden) | This property indicates whether this overlay is empty or not. |
| IsVisible | Boolean | Overlay | Gets or sets if this overlay is visible. |
| Layers | GeoCollection<AdornmentLayer> | This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. | |
| MapArguments | MapArguments | Overlay | Gets or sets the mapArguments for this overlay. |
| Name | String | Overlay | Gets or sets the name of this overaly. |
| Opacity | Double | Overlay | Gets or sets the opacity for this overlay. |
| ShowLogo | Boolean | Gets or sets a value indicating whether logo. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 DrawingException | DrawingExceptionOverlayEventArgs | Overlay | Occurs before exception is drawing on map. |
| DrawnException | DrawnExceptionOverlayEventArgs | Overlay | Occurs after exception is drawn on map. |
Public Constructors
AdornmentOverlay()
Initializes a new instance of the class.
Parameters
| Name | Type | Description |
|---|
Protected Constructors
Public Methods
Close()
This method will simulate the Close interaction.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Dispose()
This method dispose unmanaged resource used in this class.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Draw(MapArguments, OverlayRefreshType)
This method draws the overlay with the provided extent in world coordinate.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> | This parameter maintains current map information for calculating mechanism. |
| refreshType | OverlayRefreshType<!– ThinkGeo.MapSuite.AndroidEdition.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. |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
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
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | A RectangleShape indicating the bounding box of this overlay. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Initialize(MapArguments)
This method initializes overlay object.
Remarks
This is a wrapper method for the virtual method InitializeCore.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> | This parameter maintains current map information for calculating mechanism. |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Open()
This method will simulate the Open interaction.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
PostTransform(TransformArguments, MapArguments)
This method will simulate the PostTransform interaction.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| transformInfo | TransformArguments<!– ThinkGeo.MapSuite.AndroidEdition.TransformArguments –> | This parameter maintains the transfrom information for calculating transform. |
| mapArguments | MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> | This parameter maintains current map information for calculating mechanism. |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
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
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
CloseCore()
This protected virtual method is the Core method of Close API.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Dispose(Boolean)
Releases unmanaged and - optionally - managed resources.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| isDisposing | Boolean<!– System.Boolean –> | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay(overriden) –> Go Back
DrawCore(MapArguments, OverlayRefreshType)
This method draws the overlay with the provided extent in world coordinate.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> | This parameter maintains current map information for calculating mechanism. |
| refreshType | OverlayRefreshType<!– ThinkGeo.MapSuite.AndroidEdition.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. |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay(overriden) –> Go Back
DrawException(GeoCanvas, Exception)
This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Remarks
This method can be overriden its logic by rewrite the DrawExceptionCore.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| geoCanvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | |
| exception | Exception<!– System.Exception –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
DrawExceptionCore(GeoCanvas, Exception)
This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| geoCanvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | |
| ex | Exception<!– System.Exception –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object(overriden) –> Go Back
GetBoundingBoxCore()
This method returns the bounding box of the Overlay.
Remarks
This method returns the bounding box of the Overlay.
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This method returns the bounding box of the Overlay. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
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
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> | This parameter maintains current map information for calculating mechanism. |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay(overriden) –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
OnDrawingException(DrawingExceptionOverlayEventArgs)
This method raises before the overlay is drawing exception.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawingExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs –> | This parameter is the event argument for DrawingException event. |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
OnDrawnException(DrawnExceptionOverlayEventArgs)
This method raises after the overlay is drawn exception.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawnExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs –> | This parameter is the event argument for DrawingException event. |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
OpenCore()
This protected virtual method is the Core method of Open API.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
PostTransformCore(TransformArguments, MapArguments)
This protected virtual method is the Core method of PostTransform API.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| transformInfo | TransformArguments<!– ThinkGeo.MapSuite.AndroidEdition.TransformArguments –> | This parameter maintains the transfrom information for calculating transform. |
| mapArguments | MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> | This parameter maintains current map information for calculating mechanism. |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
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
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Public Properties
Attribution
Gets or sets the attribution for this overlay.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
DrawingExceptionMode
This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
Return Value
| Return Type |
|---|
| DrawingExceptionMode<!– ThinkGeo.MapSuite.Core.DrawingExceptionMode –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
DrawingQuality
Gets or sets the drawingQuality for this overlay.
Return Value
| Return Type |
|---|
| DrawingQuality<!– ThinkGeo.MapSuite.Core.DrawingQuality –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
IsEmpty
This property indicates whether 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
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay(overriden) –> Go Back
IsVisible
Gets or sets if this overlay is visible.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Layers
This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.
Return Value
| Return Type |
|---|
| GeoCollection<AdornmentLayer><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.AdornmentLayer} –> |
<!– ThinkGeo.MapSuite.AndroidEdition.AdornmentOverlay –> Go Back
MapArguments
Gets or sets the mapArguments for this overlay.
Return Value
| Return Type |
|---|
| MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Name
Gets or sets the name of this overaly.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
Opacity
Gets or sets the opacity for this overlay.
Return Value
| Return Type |
|---|
| Double<!– System.Double –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
ShowLogo
Gets or sets a value indicating whether logo.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.AndroidEdition.AdornmentOverlay –> Go Back
Protected Properties
Public Events
DrawingException
Occurs before exception is drawing on map.
Event Arguments
| Event Arguments |
|---|
| DrawingExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
DrawnException
Occurs after exception is drawn on map.
Event Arguments
| Event Arguments |
|---|
| DrawnExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.AndroidEdition.Overlay –> Go Back
NOTOC AndroidEdition ThinkGeo.MapSuite.AndroidEdition UpdateDocumentation
thinkgeo.mapsuite.androidedition.adornmentoverlay.1440040127.txt.gz · Last modified: 2015/09/21 10:28 (external edit)