User Tools

Site Tools


thinkgeo.mapsuite.desktopedition.layeroverlay

This is an old revision of the document!


ThinkGeo.MapSuite.DesktopEdition.LayerOverlay

: This class represents a group of layers; each layer can be of any layer type.

Inheritance Hierarchy

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

Members Summary

Public Constructors

LayerOverlay()

  • Initialize an instance of the LayerOverlay class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#LayerOverlay.28.29
Parameters

Protected Constructors

Public Methods

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.LayerOverlay#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.LayerOverlay#DrawPreview.28GeoCanvas.29
Return Value
  • 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.LayerOverlay#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.LayerOverlay#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.LayerOverlay#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.LayerOverlay#GetType.28.29
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

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.LayerOverlay#RefreshCore.28GeoCanvas.2C_RectangleShape.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawCore(GeoCanvas)

  • Draw all of the layers to the image object using the parameters specified.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#DrawCore.28GeoCanvas.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:The GeoCanvas object that the layers will draw on.

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.LayerOverlay#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.LayerOverlay#OnDrawn.28DrawnOverlayEventArgs.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.LayerOverlay#DrawPreviewCore.28GeoCanvas.29
Return Value
  • 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.LayerOverlay#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.LayerOverlay#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.LayerOverlay#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.LayerOverlay#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.LayerOverlay#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.LayerOverlay#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.LayerOverlay#MemberwiseClone.28.29
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

Layers

Gets a GeoCollection that contains the layers that will draw on the image.

Remarks

The <strong>Layers</strong> property holds all of the layers that are used by the <strong>Draw</strong> method. The Draw method loops through all layers to filter out features and draw on the image with the specified styles.

Return Value
Remarks

If the layer count is zero, returns true. Otherwise, returns false.

Return Value
  • Type:Boolean

Attribution

N/A

Remarks
Return Value
  • Type:String

Lock

This property gets the OverlayLock object.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#Lock

Return Value

IsBase

Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#IsBase

Return Value
  • Type:Boolean

DrawingExceptionMode

This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#DrawingExceptionMode

Return Value

IsVisible

Gets or sets a value that indicates whether the overlay is visible on the map.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#IsVisible

Return Value
  • Type:Boolean

Name

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

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#Name

Return Value
  • Type:String

TileCache

This property gets or sets the TileCache used for the overlay.

Remarks

The TileCache system is always used for better performance, especially in the case where your application tiles can be pregenerated.

Return Value

PreviewTileCache

This property gets or sets the preview tile cache system. In order for this system to work, you must be in multi-threaded mode and have the tile cache set.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#PreviewTileCache

Return Value

DrawingTime

This property gets the last drawing time for the Overlay.

Remarks

We track the drawing time for the Overlay and report it back in this method. This is useful to determine the speed of various Overlays.

Return Value
  • Type:TimeSpan

AutoRefreshInterval

N/A

Remarks

For the most updated Info for this topic, please check it here:

Return Value
  • Type:TimeSpan

Protected Properties

rxM=

N/A

Remarks

N/A

Return Value

Public Events

Drawing This event will be fired before the Overlay is drawn.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#OnDrawing.28DrawingOverlayEventArgs.29

Event Arguments:DrawingOverlayEventArgs

Drawn This event will be fired after the Overlay is drawn.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#OnDrawn.28DrawnOverlayEventArgs.29

Event Arguments:DrawnOverlayEventArgs

DrawingAttribution N/A

Remarks
Remarks
Remarks

For the most updated Info for this topic, please check it here:

Event Arguments:RequestedDrawingOverlayEventArgs

RequestingDrawing N/A

Remarks

For the most updated Info for this topic, please check it here:

Event Arguments:RequestingDrawingOverlayEventArgs

thinkgeo.mapsuite.desktopedition.layeroverlay.1442909485.txt.gz · Last modified: 2015/09/22 08:11 by admin