User Tools

Site Tools

Trace: • thinkgeo.mapsuite.desktopedition.googlemapsoverlay

Sidebar

ThinkGeo Cloud

ThinkGeo UI Controls

ThinkGeo Open Source

Help and Support

External Resources

thinkgeo.mapsuite.desktopedition.googlemapsoverlay

Table of Contents

ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

This class represents the Overlay used to display a Google Map.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.DesktopEdition.Overlay
      • ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay

Members Summary

Public Constructors

GoogleMapsOverlay()

  • This is the constructor of the class.
Remarks
  • If you use this constructor, you have to set the properties manually before use, otherwise it will use their default values.
Parameters

GoogleMapsOverlay(String,String,String)

  • This is the constructor the for the class.
Remarks
  • This constructor initializes a new layer and assgin a license key.
Parameters
  • cacheDirectory
    • Type:String
    • Description:The cacheDirectory for the GoogleMapsOverlay.
  • clientId
    • Type:String
    • Description:The clientId for the GoogleMapsOverlay.
  • privateKey
    • Type:String
    • Description:The privateKey for the GoogleMapsOverlay.

GoogleMapsOverlay(String,String,String,WebProxy)

  • This is the constructor the for the class.
Remarks
  • This constructor initializes a new layer and assgin a license key.
Parameters
  • cacheDirectory
    • Type:String
    • Description:The cacheDirectory for the GoogleMapsOverlay.
  • clientId
    • Type:String
    • Description:The clientId for the GoogleMapsOverlay.
  • privateKey
    • Type:String
    • Description:The privateKey for the GoogleMapsOverlay.
  • webProxy
    • Type:WebProxy
    • Description:N/A

Protected Constructors

Public Methods

GetPictureFormatString()

  • This method gets a string that represents the picture format from Google Maps.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#GetPictureFormatString.28.29
Return Value
  • Type:String
  • Description:Returns a string representing the picture format from GoogleMaps.
Parameters

Dispose()

  • Releases the unmanaged resources.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#Dispose.28.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

ClearCache()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#ClearCache.28.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

ClearCache(String,TimeSpan,Double)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#ClearCache.28String.2C_TimeSpan.2C_Double.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • cacheFolder
    • Type:String
    • Description:N/A
  • tileExpiration
    • Type:TimeSpan
    • Description:N/A
  • maxSizeInMegabytes
    • Type:Double
    • Description:N/A

Refresh(GeoCanvas,RectangleShape)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#Refresh.28GeoCanvas.2C_RectangleShape.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawPreview(GeoCanvas)

  • This method will be used to draw preview tiles to the canvas.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#DrawPreview.28GeoCanvas.29
Return Value
  • Type:TilesExistingType
  • Description:The tile existing type, which indicates whether any tiles exist.
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object to draw on.

Draw(GeoCanvas)

  • This method draws the Overlay.
Remarks
  • This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the overlay based on the extent you provided. 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
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object to draw on.

RequestDrawing()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(RectangleShape)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(TimeSpan)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

ToString()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#ToString.28.29
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#Equals.28Object.29
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#GetHashCode.28.29
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#GetType.28.29
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

DrawCore(GeoCanvas)

  • This method draws the GoogleMapsOverlay.
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:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object or a GeoImage to draw on.

OnSendingWebRequest(SendingWebRequestEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#OnSendingWebRequest.28SendingWebRequestEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnSentWebRequest(SentWebRequestEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#OnSentWebRequest.28SentWebRequestEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawing(DrawingOverlayEventArgs)

  • This event will be fired before Overlay is drawn.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#OnDrawing.28DrawingOverlayEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawn(DrawnOverlayEventArgs)

  • This event will be fired after Overlay is drawn.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#OnDrawn.28DrawnOverlayEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

RefreshCore(GeoCanvas,RectangleShape)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#RefreshCore.28GeoCanvas.2C_RectangleShape.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawPreviewCore(GeoCanvas)

  • This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#DrawPreviewCore.28GeoCanvas.29
Return Value
  • Type:TilesExistingType
  • Description:The tile existing type, which indicates whether any tiles exist.
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object to draw on.

sBM=(GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawAttributionCore(GeoCanvas)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#DrawAttributionCore.28GeoCanvas.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawException(GeoCanvas,Exception)

  • This method will draw on the canvas when an exception occurs during the drawing process.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#DrawException.28GeoCanvas.2C_Exception.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object to draw on.
  • e
    • Type:Exception
    • Description:This parameter is the exception that is occurring.

DrawExceptionCore(GeoCanvas,Exception)

  • This method is the Core method of DrawException, which can be overridden if you want to change its logic. This method will draw on the canvas when an exception occurs during drawing process.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#DrawExceptionCore.28GeoCanvas.2C_Exception.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object to draw on.
  • e
    • Type:Exception
    • Description:This parameter is the exception that is occurring.

OnRequestedDrawing(RequestedDrawingOverlayEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnRequestingDrawing(RequestingDrawingOverlayEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#Finalize.28.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay#MemberwiseClone.28.29
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

TileMode

  • N/A
Remarks
Return Value
  • Type:Int32

MapType

  • This property gets or sets the map types available from Google Maps.
Remarks
Return Value
  • Type:String

PrivateKey

  • Gets or sets a value that is unique to your client ID, please keep your key secure.
Remarks
Return Value
  • Type:WebProxy

TileCache

  • N/A
Remarks
Return Value

ProjectedTileCache

  • N/A
Remarks
Return Value
  • Type:TimeSpan

MaxCacheSizeInMegabytes

  • N/A
Remarks
Return Value
  • Type:String

Lock

  • This property gets the OverlayLock object.
Remarks
Return Value
  • Type:Boolean

DrawingExceptionMode

  • This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
Remarks
Return Value
  • Type:Boolean

Name

  • Gets or sets the name of the overlay, which can be used to represent a specific overlay.
Remarks
Return Value

IsEmpty

  • This property can be overridden by its base class. If it is not overridden, its default return value will be false. If this property is empty, we can skip drawing to achieve better performance.
Remarks

Event Arguments:SendingWebRequestEventArgs

SentWebRequest

  • N/A
Remarks

Event Arguments:DrawingOverlayEventArgs

Drawn

  • This event will be fired after the Overlay is drawn.
Remarks

Event Arguments:DrawingAttributionOverlayEventArgs

DrawnAttribution

  • N/A
Remarks
thinkgeo.mapsuite.desktopedition.googlemapsoverlay.txt · Last modified: 2017/03/16 21:59 (external edit)

Page Tools