====== ThinkGeo.MapSuite.AndroidEdition.LayerOverlay ====== {{section>upgrade_map_suite_to_10.0}} This class represents a group of layers; each layer can be of any layer type. ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.AndroidEdition.Overlay *ThinkGeo.MapSuite.AndroidEdition.TileOverlay ***ThinkGeo.MapSuite.AndroidEdition.LayerOverlay** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} LayerOverlay() ** * //Initializes a new instance of the class.// == Remarks == * //N/A// == Parameters ==
** {{wiki:PublicMethod.gif|}} LayerOverlay(IEnumerable) ** * //Initializes a new instance of the class.// == Remarks == * //N/A// == Parameters == * //layers// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> * Description:This parameter indicates a layer collection which needs to be drawn.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan,BufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Core.BufferTimeType|BufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan,BufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Core.BufferTimeType|BufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable,TimeSpan,BufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Core.BufferTimeType|BufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Initialize(MapArguments) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //mapArguments// * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] * Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extent// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} Draw(MapArguments,OverlayRefreshType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //mapArguments// * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] * Description:N/A * //refreshType// * Type:[[ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType|OverlayRefreshType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} PostTransform(TransformArguments,MapArguments) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //transformInfo// * Type:[[ThinkGeo.MapSuite.AndroidEdition.TransformArguments|TransformArguments]] * Description:N/A * //mapArguments// * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] * Description:N/A
** {{wiki:PublicMethod.gif|}} Close() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Open() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Dispose() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} GetTileCore(Context) ** * //Chooses a tile object to form the TileOverlay. When overriding this method, consider the initialize parameters setting on the tile.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.TileView|TileView]] * Description:A tile object to form the TileOverlay. == Parameters == * //context// * Type:Context * Description:Interface to global information about an application environment.
** {{wiki:ProtectedMethod.gif|}} DrawTileCore(GeoCanvas,TileView) ** * //Redraws a specified tile with the provided world extent.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //geoCanvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:This parameter is the canvas object to draw on. * //tile// * Type:[[ThinkGeo.MapSuite.AndroidEdition.TileView|TileView]] * Description:A Tile object that is created by the GetTile(Context) method to draw.
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** * //This method returns the bounding box of the Overlay.// == Remarks == * //This method returns the bounding box of the Overlay.// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:This method returns the bounding box of the Overlay. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} 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 == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawCore(MapArguments,OverlayRefreshType) ** * //This method draws the InterativeOverlay abstract class. You have to override this API in its sub concrete classes, Or you will see nothing.// == Remarks == * //This method draws the representation of the overlay based on the extent you provided. When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.// == Return Value == * Type:Void * Description:none == Parameters == * //mapArguments// * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] * Description:This parameter maintains current map information for calculating mechanism. * //refreshType// * Type:[[ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType|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.
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** * //This protected virtual method is the Core method of Open API.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** * //This protected virtual method is the Core method of Close API.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawTile(TileView,MapArguments) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //tile// * Type:[[ThinkGeo.MapSuite.AndroidEdition.TileView|TileView]] * Description:N/A * //mapArguments// * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} PostTransformCore(TransformArguments,MapArguments) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //transformInfo// * Type:[[ThinkGeo.MapSuite.AndroidEdition.TransformArguments|TransformArguments]] * Description:N/A * //mapArguments// * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} Dispose(Boolean) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //disposing// * Type:Boolean * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetTile(Context) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.TileView|TileView]] * Description:N/A == Parameters == * //context// * Type:Context * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetTileMatrix(Double,Int32,Int32,GeographyUnit) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] * Description:N/A == Parameters == * //scale// * Type:Double * Description:N/A * //tileWidth// * Type:Int32 * Description:N/A * //tileHeight// * Type:Int32 * Description:N/A * //boundingBoxUnit// * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetTileMatrixCells(MapArguments,Double) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection<[[ThinkGeo.MapSuite.Core.TileMatrixCell|TileMatrixCell]]> * Description:N/A == Parameters == * //mapArguments// * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] * Description:N/A * //targetScale// * Type:Double * Description:N/A
** {{wiki:ProtectedMethod.gif|}} EhU=() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} RefreshCore(RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extent// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} InitializeCore(MapArguments) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //mapArgument// * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //geoCanvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //exception// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //geoCanvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //ex// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} LockLayerMode ** * //This property gets and sets the lock mode while drawing layers.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.LockLayerMode|LockLayerMode]] ** {{wiki:PublicProperty.gif|}} Layers ** * //Gets a GeoCollection that contains the layers that will draw on the image.// == Remarks == * //The Layers property holds all of the layers that are used by the Draw method. The Draw method loops through all layers to filter out features and draw on the image with the specified styles.// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.GeoCollection[[ThinkGeo.MapSuite.Core.Layer, MapSuitePortableCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection]] ** {{wiki:PublicProperty.gif|}} 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 == * Type:Boolean ** {{wiki:PublicProperty.gif|}} TransitionEffect ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.TransitionEffect|TransitionEffect]] ** {{wiki:PublicProperty.gif|}} LayerType ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:LayerType ** {{wiki:PublicProperty.gif|}} TileSizeMode ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.TileSizeMode|TileSizeMode]] ** {{wiki:PublicProperty.gif|}} TileCache ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] ** {{wiki:PublicProperty.gif|}} TileSnappingMode ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.TileSnappingMode|TileSnappingMode]] ** {{wiki:PublicProperty.gif|}} TileType ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.TileType|TileType]] ** {{wiki:PublicProperty.gif|}} IsVisible ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:TimeSpan ** {{wiki:PublicProperty.gif|}} Name ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] ** {{wiki:PublicProperty.gif|}} Attribution ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} OverlayView ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapLayout|MapLayout]] ** {{wiki:PublicProperty.gif|}} DrawingQuality ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.DrawingQuality|DrawingQuality]] ** {{wiki:PublicProperty.gif|}} Opacity ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Double ** {{wiki:PublicProperty.gif|}} MapArguments ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]] ** {{wiki:PublicProperty.gif|}} CanRefreshRegion ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} /xQ= ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:ProtectedProperty.gif|}} AhU= ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:ProtectedProperty.gif|}} BRU= ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:ProtectedProperty.gif|}} SingleTile ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.AndroidEdition.TileView|TileView]] ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} DrawingException ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnException ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]]