User Tools

Site Tools


thinkgeo.mapsuite.iosedition.openstreetmapoverlay

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay

<!– Class –> This class represents an overlay that requesting images from OpenStreet Map Service.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodOpenStreetMapOverlay This is constructor of OpenStreetMapOverlay.
Public MethodOpenStreetMapOverlay GeoWebProxy This is constructor of OpenStreetMapOverlay.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodClose Overlay Closes this instance.
Public MethodDispose Overlay Disposes this instance.
Public MethodDraw MapArguments, OverlayRefreshType Overlay This method draws the overlay by the specified arguments.
Public MethodEquals Object Object
Public MethodGetBoundingBox Overlay Gets the bounding box.
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodInitialize MapArguments Overlay Initializes the specified map arguments.
Public MethodPostTransform TransformArguments, MapArguments Overlay Posts the transform for the overlay.
Public MethodRefresh Overlay Refreshes this instance.
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodCloseCore Overlay(overriden) Closes the core.
Protected MethodDispose Boolean Overlay(overriden)
Protected MethodDrawCore MapArguments, OverlayRefreshType Overlay(overriden)
Protected MethodDrawException GeoCanvas, Exception Overlay Draws the exception.
Protected MethodDrawExceptionCore GeoCanvas, Exception Overlay Draws the exception core.
Protected MethodDrawTile TileView, MapArguments TileOverlay Redraws a specified tile with the provided world extent.
Protected MethodDrawTileCore GeoCanvas, TileView TileOverlay(overriden) This method overrides from its base class TileOverlay. It actually requests image for the passed tile with the passed world extent.
Protected MethodFinalize Object(overriden)
Protected MethodGetBoundingBoxCore Overlay(overriden) This method gets a world extent for holding the entire OpenStreet map.
Protected MethodGetTile TileOverlay Chooses a tile object to form the TileOverlay. When overriding this method, consider the initialize parameters setting on the tile.
Protected MethodGetTileCore TileOverlay(overriden) This method gets a concrete tile class to form this overlay.
Protected MethodGetTileMatrix Double, Int32, Int32, GeographyUnit TileOverlay Gets the tile matrix for TileOverlay.
Protected MethodGetTileMatrixCells GeographyUnit, RectangleShape, Double TileOverlay Gets the tile matrix cells for TileOverlay.
Protected MethodInitializeCore MapArguments Overlay Initializes the core.
Protected MethodMemberwiseClone Object
Protected MethodOnDrawingException DrawingExceptionOverlayEventArgs Overlay Handles the event.
Protected MethodOnDrawnException DrawnExceptionOverlayEventArgs Overlay Handles the event.
Protected MethodOnSendingWebRequest SendingWebRequestEventArgs This method saves overlay state to a byte array.
Protected MethodOnSentWebRequest SentWebRequestEventArgs Handles the event.
Protected MethodPostTransformCore TransformArguments, MapArguments Overlay(overriden)
Protected MethodRefreshCore Overlay Refreshes the core.

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Overlay Gets or sets the attribution.
Public PropertyCustomServerUris Collection<Uri> Gets the custom server uris.
Public PropertyDrawingExceptionMode DrawingExceptionMode Overlay This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
Public PropertyDrawingQuality DrawingQuality Overlay Gets or sets the drawing quality.
Public PropertyIsCacheOnly Boolean TileOverlay Gets or sets a value indicating whether this instance is cache only.
Public PropertyIsEmpty Boolean Overlay Gets a value indicating whether this instance is empty.
Public PropertyIsVisible Boolean Overlay(overriden)
Public PropertyMapArguments MapArguments Overlay Gets or sets the map arguments.
Public PropertyName String Overlay Gets or sets the name.
Public PropertyOpacity Double Overlay Gets or sets the opacity.
Public PropertyOverlayView UIView Overlay Gets or sets the overlay view.
Public PropertyProjectedTileCache BitmapTileCache Gets or sets the projected tile cache.
Public PropertyProjectionFromSphericalMercator Projection Gets or sets the projection from spherical mercator.
Public PropertyTileCache BitmapTileCache TileOverlay(overriden) Gets or sets the tile cache.
Public PropertyTileHeight Int32 TileOverlay Gets or sets the height of the tile.
Public PropertyTileSnappingMode TileSnappingMode TileOverlay Gets or sets the tile snapping mode.
Public PropertyTileType TileType TileOverlay Gets and sets the overlay is formed by multiple tiles or single tile.
Public PropertyTileWidth Int32 TileOverlay Gets or sets the width of the tile.
Public PropertyTimeoutInSeconds Int32 Gets or sets the length of time, in seconds, before the request times out.
Public PropertyTransitionEffect TransitionEffect TileOverlay Gets or sets the transition effect.
Public PropertyWebProxy GeoWebProxy Gets or sets the WebProxy for using OpenStreet map service.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyDrawingView UIView TileOverlay Gets or sets the drawing view.
Protected PropertyStretchView UIView TileOverlay Gets or sets the stretch view.

Public Events

Public Constructors

OpenStreetMapOverlay()

This is constructor of OpenStreetMapOverlay.

Parameters

Name Type Description

Go Back

OpenStreetMapOverlay(GeoWebProxy)

This is constructor of OpenStreetMapOverlay.

Parameters

Name Type Description
webProxy GeoWebProxy<!– ThinkGeo.MapSuite.Core.GeoWebProxy –> This parameter indicates a WebProxy for requesting image from OpenStreet imagery service.

Go Back

Protected Constructors

Public Methods

Close()

Closes this instance.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Dispose()

Disposes this instance.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Draw(MapArguments, OverlayRefreshType)

This method draws the overlay by the specified arguments.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> This parameter indicates an mapArguments to draw the overlay.
refreshType OverlayRefreshType<!– ThinkGeo.MapSuite.iOSEdition.OverlayRefreshType –> This parameter indicates whether this overlay needs to be refresh or not.

<!– ThinkGeo.MapSuite.iOSEdition.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()

Gets the bounding box.

Return Value

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> A RectangleShape value for the overlay.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.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)

Initializes the specified map arguments.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> The map arguments.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

PostTransform(TransformArguments, MapArguments)

Posts the transform for the overlay.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
transformInfo TransformArguments<!– ThinkGeo.MapSuite.iOSEdition.TransformArguments –> The transform information.
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> The map arguments.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Refresh()

Refreshes this instance.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

ToString()

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

CloseCore()

Closes the core.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay(overriden) –> Go Back

Dispose(Boolean)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
isDisposing Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay(overriden) –> Go Back

DrawCore(MapArguments, OverlayRefreshType)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –>
refreshType OverlayRefreshType<!– ThinkGeo.MapSuite.iOSEdition.OverlayRefreshType –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay(overriden) –> Go Back

DrawException(GeoCanvas, Exception)

Draws the exception.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
geoCanvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> The geo canvas.
exception Exception<!– System.Exception –> The exception.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

DrawExceptionCore(GeoCanvas, Exception)

Draws the exception core.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
geoCanvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> The geo canvas.
ex Exception<!– System.Exception –> The ex.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

DrawTile(TileView, MapArguments)

Redraws a specified tile with the provided world extent.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
tile TileView<!– ThinkGeo.MapSuite.iOSEdition.TileView –> A Tile object that is created by the GetTile() method to draw.
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> A mapArguments for drawing the passed tile.

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

DrawTileCore(GeoCanvas, TileView)

This method overrides from its base class TileOverlay. It actually requests image for the passed tile with the passed world extent.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
geoCanvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> The geo canvas.
tile TileView<!– ThinkGeo.MapSuite.iOSEdition.TileView –> A tile object that creating by the GetTileCore method. It's the tile which needs to be draw in this mehtod.

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay(overriden) –> Go Back

Finalize()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object(overriden) –> Go Back

GetBoundingBoxCore()

This method gets a world extent for holding the entire OpenStreet map.

Return Value

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> RectangleShape.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay(overriden) –> Go Back

GetTile()

Chooses a tile object to form the TileOverlay. When overriding this method, consider the initialize parameters setting on the tile.

Return Value

Return Type Description
TileView<!– ThinkGeo.MapSuite.iOSEdition.TileView –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

GetTileCore()

This method gets a concrete tile class to form this overlay.

Return Value

Return Type Description
TileView<!– ThinkGeo.MapSuite.iOSEdition.TileView –> A concrete Tile object that for requesting images from OpenStreet serverice.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay(overriden) –> Go Back

GetTileMatrix(Double, Int32, Int32, GeographyUnit)

Gets the tile matrix for TileOverlay.

Return Value

Return Type Description
TileMatrix<!– ThinkGeo.MapSuite.Core.TileMatrix –> TileMatrix.

Parameters

Name Type Description
scale Double<!– System.Double –> The scale.
tileWidth Int32<!– System.Int32 –> Width of the tile.
tileHeight Int32<!– System.Int32 –> Height of the tile.
boundingBoxUnit GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> The bounding box unit.

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

GetTileMatrixCells(GeographyUnit, RectangleShape, Double)

Gets the tile matrix cells for TileOverlay.

Return Value

Return Type Description
Collection<TileMatrixCell><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.TileMatrixCell} –> Collection<TileMatrixCell>.

Parameters

Name Type Description
mapUnit GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> The map unit.
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> The target extent.
targetScale Double<!– System.Double –> The target scale.

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

InitializeCore(MapArguments)

Initializes the core.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
mapArgument MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –> The map argument.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

MemberwiseClone()

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

OnDrawingException(DrawingExceptionOverlayEventArgs)

Handles the event.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
args DrawingExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.iOSEdition.DrawingExceptionOverlayEventArgs –> The instance containing the event data.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

OnDrawnException(DrawnExceptionOverlayEventArgs)

Handles the event.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
args DrawnExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.iOSEdition.DrawnExceptionOverlayEventArgs –> The instance containing the event data.

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

OnSendingWebRequest(SendingWebRequestEventArgs)

This method saves overlay state to a byte array.

Return Value

Return Type Description
Void<!– System.Void –> A byte array indicates current overlay state.

Parameters

Name Type Description
e SendingWebRequestEventArgs<!– ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs –> The instance containing the event data.

<!– ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay –> Go Back

OnSentWebRequest(SentWebRequestEventArgs)

Handles the event.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e SentWebRequestEventArgs<!– ThinkGeo.MapSuite.Core.SentWebRequestEventArgs –> The instance containing the event data.

<!– ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay –> Go Back

PostTransformCore(TransformArguments, MapArguments)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
transformInfo TransformArguments<!– ThinkGeo.MapSuite.iOSEdition.TransformArguments –>
mapArguments MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay(overriden) –> Go Back

RefreshCore()

Refreshes the core.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Public Properties

Attribution

Gets or sets the attribution.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

CustomServerUris

Gets the custom server uris.

Return Value

Return Type
Collection<Uri><!– System.Collections.ObjectModel.Collection{System.Uri} –>

<!– ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay –> 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.iOSEdition.Overlay –> Go Back

DrawingQuality

Gets or sets the drawing quality.

Return Value

Return Type
DrawingQuality<!– ThinkGeo.MapSuite.Core.DrawingQuality –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

IsCacheOnly

Gets or sets a value indicating whether this instance is cache only.

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

IsEmpty

Gets a value indicating whether this instance is empty.

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

IsVisible

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay(overriden) –> Go Back

MapArguments

Gets or sets the map arguments.

Return Value

Return Type
MapArguments<!– ThinkGeo.MapSuite.iOSEdition.MapArguments –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Name

Gets or sets the name.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

Opacity

Gets or sets the opacity.

Return Value

Return Type
Double<!– System.Double –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

OverlayView

Gets or sets the overlay view.

Return Value

Return Type
UIView<!– MonoTouch.UIKit.UIView –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

ProjectedTileCache

Gets or sets the projected tile cache.

Return Value

Return Type
BitmapTileCache<!– ThinkGeo.MapSuite.Core.BitmapTileCache –>

<!– ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay –> Go Back

ProjectionFromSphericalMercator

Gets or sets the projection from spherical mercator.

Return Value

Return Type
Projection<!– ThinkGeo.MapSuite.Core.Projection –>

<!– ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay –> Go Back

TileCache

Gets or sets the tile cache.

Return Value

Return Type
BitmapTileCache<!– ThinkGeo.MapSuite.Core.BitmapTileCache –>

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay(overriden) –> Go Back

TileHeight

Gets or sets the height of the tile.

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

TileSnappingMode

Gets or sets the tile snapping mode.

Return Value

Return Type
TileSnappingMode<!– ThinkGeo.MapSuite.iOSEdition.TileSnappingMode –>

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

TileType

Gets and sets the overlay is formed by multiple tiles or single tile.

Return Value

Return Type
TileType<!– ThinkGeo.MapSuite.iOSEdition.TileType –>

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

TileWidth

Gets or sets the width of the tile.

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

TimeoutInSeconds

Gets or sets the length of time, in seconds, before the request times out.

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay –> Go Back

TransitionEffect

Gets or sets the transition effect.

Return Value

Return Type
TransitionEffect<!– ThinkGeo.MapSuite.iOSEdition.TransitionEffect –>

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

WebProxy

Gets or sets the WebProxy for using OpenStreet map service.

Return Value

Return Type
GeoWebProxy<!– ThinkGeo.MapSuite.Core.GeoWebProxy –>

<!– ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay –> Go Back

Protected Properties

DrawingView

Gets or sets the drawing view.

Return Value

Return Type
UIView<!– MonoTouch.UIKit.UIView –>

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

StretchView

Gets or sets the stretch view.

Return Value

Return Type
UIView<!– MonoTouch.UIKit.UIView –>

<!– ThinkGeo.MapSuite.iOSEdition.TileOverlay –> Go Back

Public Events

DrawingException

This event raises when exception.

Event Arguments

Event Arguments
DrawingExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.iOSEdition.DrawingExceptionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

DrawnException

This event raises when exception.

Event Arguments

Event Arguments
DrawnExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.iOSEdition.DrawnExceptionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.iOSEdition.Overlay –> Go Back

SendingWebRequest

Occurs when web request.

Event Arguments

Event Arguments
SendingWebRequestEventArgs<!– ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs –>

<!– ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay –> Go Back

SentWebRequest

Occurs when web request.

Event Arguments

Event Arguments
SentWebRequestEventArgs<!– ThinkGeo.MapSuite.Core.SentWebRequestEventArgs –>

<!– ThinkGeo.MapSuite.iOSEdition.OpenStreetMapOverlay –> Go Back

NOTOC iOSEdition ThinkGeo.MapSuite.iOSEdition UpdateDocumentation

thinkgeo.mapsuite.iosedition.openstreetmapoverlay.1440040131.txt.gz · Last modified: 2015/09/21 08:34 (external edit)