thinkgeo.mapsuite.androidedition.markeroverlay
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.androidedition.markeroverlay [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.AndroidEdition.MarkerOverlay ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class represents an overlay which maintaining markers. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.AndroidEdition.Overlay]] | ||
| - | ***[[ThinkGeo.MapSuite.AndroidEdition.MarkerOverlay]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#MarkerOverlay()|MarkerOverlay]] | | | Initializes a new instance of the class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method will simulate the Close interaction. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Dispose()|Dispose]] | | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method dispose unmanaged resource used in this class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(MapArguments, OverlayRefreshType)|Draw]] | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]], [[ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType|OverlayRefreshType]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method draws the overlay with the provided extent in world coordinate. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]] | | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method gets a bounding box of the Overlay. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Initialize(MapArguments)|Initialize]] | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method initializes overlay object. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method will simulate the Open interaction. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#PostTransform(TransformArguments, MapArguments)|PostTransform]] | [[ThinkGeo.MapSuite.AndroidEdition.TransformArguments|TransformArguments]], [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method will simulate the PostTransform interaction. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Refresh()|Refresh]] | | [[ThinkGeo.MapSuite.AndroidEdition.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. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]] | | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This protected virtual method is the Core method of Close API. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Dispose(Boolean)|Dispose]] | Boolean | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]](overriden) | Releases unmanaged and - optionally - managed resources. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(MapArguments, OverlayRefreshType)|DrawCore]] | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]], [[ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType|OverlayRefreshType]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]](overriden) | This method creates markers in the provided world extent and places on the overlay. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawException(GeoCanvas, Exception)|DrawException]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawExceptionCore(GeoCanvas, Exception)|DrawExceptionCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object(overriden) | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]] | | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method returns the bounding box of the Overlay. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#InitializeCore(MapArguments)|InitializeCore]] | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method initializes overlay object. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingException(DrawingExceptionOverlayEventArgs)|OnDrawingException]] | [[ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method raises before the overlay is drawing exception. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnException(DrawnExceptionOverlayEventArgs)|OnDrawnException]] | [[ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This method raises after the overlay is drawn exception. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This protected virtual method is the Core method of Open API. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#PostTransformCore(TransformArguments, MapArguments)|PostTransformCore]] | [[ThinkGeo.MapSuite.AndroidEdition.TransformArguments|TransformArguments]], [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]](overriden) | This protected virtual method is the Core method of PostTransform API. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#RefreshCore()|RefreshCore]] | | [[ThinkGeo.MapSuite.AndroidEdition.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. | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | Gets or sets the attribution for this overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingQuality|DrawingQuality]] | [[ThinkGeo.MapSuite.Core.DrawingQuality|DrawingQuality]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | Gets or sets the drawingQuality for this overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsEmpty|IsEmpty]] | Boolean | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | This property gets if this overlay is empty or not. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]] | Boolean | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | Gets or sets if this overlay is visible. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#MapArguments|MapArguments]] | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | Gets or sets the mapArguments for this overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Markers|Markers]] | [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.AndroidEdition.Marker|Marker]]> | | A collection that holds all the marker objects adding in the overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | Gets or sets the name of this overaly. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Opacity|Opacity]] | Double | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | Gets or sets the opacity for this overlay. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingException|DrawingException]] | [[ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | Occurs before exception is drawing on map. | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnException|DrawnException]] | [[ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]] | [[ThinkGeo.MapSuite.AndroidEdition.Overlay|Overlay]] | Occurs after exception is drawn on map. | | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== MarkerOverlay() ==== | ||
| - | Initializes a new instance of the class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== 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 --> | ||
| - | [[#Public Methods|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 --> | ||
| - | [[#Public Methods|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 | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.AndroidEdition.MapArguments --> | This parameter maintains current map information for calculating mechanism. | | ||
| - | | refreshType | [[ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType|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 --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|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 ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | A RectangleShape indicating the bounding box of this overlay. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|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 | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.AndroidEdition.MapArguments --> | This parameter maintains current map information for calculating mechanism. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Methods|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 --> | ||
| - | [[#Public Methods|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 | [[ThinkGeo.MapSuite.AndroidEdition.TransformArguments|TransformArguments]]<!-- ThinkGeo.MapSuite.AndroidEdition.TransformArguments --> | This parameter maintains the transfrom information for calculating transform. | | ||
| - | | mapArguments | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.AndroidEdition.MapArguments --> | This parameter maintains current map information for calculating mechanism. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Methods|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 --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|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 --> | ||
| - | [[#Protected Methods|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) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawCore(MapArguments, OverlayRefreshType) ==== | ||
| - | This method creates markers in the provided world extent and places on the overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | mapArguments | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.AndroidEdition.MapArguments --> | This parameter maintains current map information for calculating mechanism. | | ||
| - | | refreshType | [[ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType|OverlayRefreshType]]<!-- ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay(overriden) --> | ||
| - | [[#Protected Methods|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 | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | ||
| - | | exception | Exception<!-- System.Exception --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Protected Methods|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 | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | ||
| - | | ex | Exception<!-- System.Exception --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object(overriden) --> | ||
| - | [[#Protected Methods|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 ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | This method returns the bounding box of the Overlay. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Protected Methods|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 ^ | ||
| - | | mapArgument | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.AndroidEdition.MapArguments --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|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 | [[ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs --> | This parameter is the event argument for DrawingException event. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Protected Methods|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 | [[ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs --> | This parameter is the event argument for DrawingException event. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Protected Methods|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 --> | ||
| - | [[#Protected Methods|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 | [[ThinkGeo.MapSuite.AndroidEdition.TransformArguments|TransformArguments]]<!-- ThinkGeo.MapSuite.AndroidEdition.TransformArguments --> | This parameter maintains the transfrom information for calculating transform. | | ||
| - | | mapArguments | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.AndroidEdition.MapArguments --> | This parameter maintains current map information for calculating mechanism. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay(overriden) --> | ||
| - | [[#Protected Methods|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 --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== Attribution ==== | ||
| - | Gets or sets the attribution for this overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== DrawingExceptionMode ==== | ||
| - | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionMode --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== DrawingQuality ==== | ||
| - | Gets or sets the drawingQuality for this overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawingQuality|DrawingQuality]]<!-- ThinkGeo.MapSuite.Core.DrawingQuality --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsVisible ==== | ||
| - | Gets or sets if this overlay is visible. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== MapArguments ==== | ||
| - | Gets or sets the mapArguments for this overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.AndroidEdition.MapArguments --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Markers ==== | ||
| - | A collection that holds all the marker objects adding in the overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.AndroidEdition.Marker|Marker]]><!-- ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.AndroidEdition.Marker} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.MarkerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Name ==== | ||
| - | Gets or sets the name of this overaly. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Opacity ==== | ||
| - | Gets or sets the opacity for this overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Double<!-- System.Double --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | ==== DrawingException ==== | ||
| - | Occurs before exception is drawing on map. | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawnException ==== | ||
| - | Occurs after exception is drawn on map. | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.AndroidEdition.Overlay --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | |||
| - | __NOTOC__ | ||
| - | [[Category:AndroidEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.AndroidEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.androidedition.markeroverlay.1440040127.txt.gz ยท Last modified: 2015/09/21 10:31 (external edit)
