Class KmlLayer.

• System.Object
  • ThinkGeo.MapSuite.Core.Layer
    • ThinkGeo.MapSuite.Core.KmlLayer

KmlLayer()

Initializes a new instance of the class.

None

KmlLayer(String)

Initializes a new instance of the class.

N/A

• kmlPathFilename
  • Type:String
  • Description:The KML path filename.

KmlLayer(String,Encoding)

Initializes a new instance of the class.

N/A

• kmlPathFilename
  • Type:String
  • Description:The KML path filename.

• encoding
  • Type:Encoding
  • Description:The encoding.

GetThreadSafetyLevel()

N/A

N/A

• Type:ThreadSafetyLevel
• Description:N/A

CloneDeep()

N/A

N/A

• Type:Layer
• Description:N/A

Open()

N/A

N/A

• Type:Void
• Description:N/A

Close()

N/A

N/A

• Type:Void
• Description:N/A

GetBoundingBox()

N/A

N/A

• Type:RectangleShape
• Description:N/A

Draw(GeoCanvas,Collection<SimpleCandidate>)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

RequestDrawing()

N/A

N/A

• Type:Void
• Description:N/A

RequestDrawing(RectangleShape)

N/A

N/A

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>)

N/A

N/A

• Type:Void
• Description:N/A

• extentsToRefresh
  • Type:IEnumerable<RectangleShape>
  • Description:N/A

RequestDrawing(TimeSpan)

N/A

N/A

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

N/A

N/A

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

N/A

N/A

• Type:Void
• Description:N/A

• extentsToRefresh
  • Type:IEnumerable<RectangleShape>
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

ToString()

N/A

N/A

• Type:String
• Description:N/A

Equals(Object)

N/A

N/A

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

N/A

N/A

• Type:Int32
• Description:N/A

GetType()

N/A

N/A

• Type:Type
• Description:N/A

CreateKmlFile(String)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

CreateKmlFile(String,Encoding)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

• encoding
  • Type:Encoding
  • Description:The encoding.

CreateKmlFile(String,FeatureLayer)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

• featureLayer
  • Type:FeatureLayer
  • Description:The feature layer.

CreateKmlFile(String,FeatureLayer,KmlFileType)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

• featureLayer
  • Type:FeatureLayer
  • Description:The feature layer.

• kmlFileType
  • Type:KmlFileType
  • Description:Type of the KML file.

CreateKmlFile(String,FeatureLayer,KmlFileType,Encoding)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

• featureLayer
  • Type:FeatureLayer
  • Description:The feature layer.

• kmlFileType
  • Type:KmlFileType
  • Description:Type of the KML file.

• encoding
  • Type:Encoding
  • Description:The encoding.

CreateKmlFile(String,RasterLayer)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

• rasterLayer
  • Type:RasterLayer
  • Description:The raster layer.

CreateKmlFile(String,RasterLayer,KmlFileType)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

• rasterLayer
  • Type:RasterLayer
  • Description:The raster layer.

• kmlFileType
  • Type:KmlFileType
  • Description:Type of the KML file.

CreateKmlFile(String,IEnumerable<MapShape>)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

• mapShapes
  • Type:IEnumerable<MapShape>
  • Description:The map shapes.

CreateKmlFile(String,IEnumerable<MapShape>,KmlFileType)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

• mapShapes
  • Type:IEnumerable<MapShape>
  • Description:The map shapes.

• kmlFileType
  • Type:KmlFileType
  • Description:Type of the KML file.

CreateKmlFile(String,IEnumerable<MapShape>,KmlFileType,Encoding)

Creates the KML file.

N/A

• Type:Void
• Description:N/A

• pathFilename
  • Type:String
  • Description:The path filename.

• mapShapes
  • Type:IEnumerable<MapShape>
  • Description:The map shapes.

• kmlFileType
  • Type:KmlFileType
  • Description:Type of the KML file.

• encoding
  • Type:Encoding
  • Description:The encoding.

AddLayerToKml(FeatureLayer,String)

Adds the layer to KML.

N/A

• Type:Void
• Description:N/A

• featureLayer
  • Type:FeatureLayer
  • Description:The feature layer.

• pathFilename
  • Type:String
  • Description:The path filename.

AddLayerToKml(RasterLayer,String)

Adds the layer to KML.

N/A

• Type:Void
• Description:N/A

• rasterLayer
  • Type:RasterLayer
  • Description:The raster layer.

• pathFilename
  • Type:String
  • Description:The path filename.

AddLayerToKml(AdornmentLayer,String)

Adds the layer to KML.

N/A

• Type:Void
• Description:N/A

• adormentLayer
  • Type:AdornmentLayer
  • Description:The adorment layer.

• pathFilename
  • Type:String
  • Description:The path filename.

AddMapShapesToKml(IEnumerable<MapShape>,String)

Adds the map shapes to KML.

N/A

• Type:Void
• Description:N/A

• MapShapes
  • Type:IEnumerable<MapShape>
  • Description:The map shapes.

• pathFilename
  • Type:String
  • Description:The path filename.

AddLayersToKml(IEnumerable<Layer>,String)

Adds the layers to KML.

N/A

• Type:Void
• Description:N/A

• layers
  • Type:IEnumerable<Layer>
  • Description:The layers.

• pathFilename
  • Type:String
  • Description:The path filename.

OpenCore()

This method opens the Layer so that it is initialized and ready to use.

This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.

• Type:Void
• Description:None

CloseCore()

This method closes the Layer and releases any resources it was using.

This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.

• Type:Void
• Description:None

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

This method draws the Layer.

This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer 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.

• Type:Void
• Description:None

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object or a GeoImage to draw on.

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:This parameter represents the labels used for collision detection and duplication checking.

GetBoundingBoxCore()

This method returns the bounding box of the Layer.

This method returns the bounding box of the Layer.

• Type:RectangleShape
• Description:This method returns the bounding box of the Layer.

GetThreadSafetyLevelCore()

N/A

N/A

• Type:ThreadSafetyLevel
• Description:N/A

CloneDeepCore()

N/A

N/A

• Type:Layer
• Description:N/A

DrawException(GeoCanvas,Exception)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• e
  • Type:Exception
  • Description:N/A

DrawExceptionCore(GeoCanvas,Exception)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• e
  • Type:Exception
  • Description:N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawingExceptionLayerEventArgs
  • Description:N/A

OnDrawnException(DrawnExceptionLayerEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawnExceptionLayerEventArgs
  • Description:N/A

DrawAttributionCore(GeoCanvas,String)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• attribution
  • Type:String
  • Description:N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• args
  • Type:DrawingAttributionLayerEventArgs
  • Description:N/A

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• args
  • Type:DrawnAttributionLayerEventArgs
  • Description:N/A

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawingProgressChangedEventArgs
  • Description:N/A

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestedDrawingLayerEventArgs
  • Description:N/A

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestingDrawingLayerEventArgs
  • Description:N/A

Finalize()

N/A

N/A

• Type:Void
• Description:N/A

MemberwiseClone()

N/A

N/A

• Type:Object
• Description:N/A

Encoding

Gets the encoding.

N/A

• Type:Encoding

KmlPathFilename

Gets or sets the KML path filename.

N/A

• Type:String

HasBoundingBox

This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs.

The default value is false.

• Type:Boolean

IsOpen

N/A

N/A

• Type:Boolean

DrawingTime

N/A

N/A

• Type:TimeSpan

Name

N/A

N/A

• Type:String

IsVisible

N/A

N/A

• Type:Boolean

Transparency

N/A

N/A

• Type:Single

IsNegative

N/A

N/A

• Type:Boolean

IsGrayscale

N/A

N/A

• Type:Boolean

DrawingExceptionMode

N/A

N/A

• Type:DrawingExceptionMode

Attribution

N/A

N/A

• Type:String

RequestDrawingInterval

N/A

N/A

• Type:TimeSpan

IsOpenCore

N/A

N/A

• Type:Boolean

StreamLoading Occurs when [stream loading].

N/A

Event Arguments:StreamLoadingEventArgs

DrawingException N/A

N/A

Event Arguments:DrawingExceptionLayerEventArgs

DrawingProgressChanged N/A

N/A

Event Arguments:DrawingProgressChangedEventArgs

DrawnException N/A

N/A

Event Arguments:DrawnExceptionLayerEventArgs

DrawingAttribution N/A

N/A

Event Arguments:DrawingAttributionLayerEventArgs

DrawnAttribution N/A

N/A

Event Arguments:DrawnAttributionLayerEventArgs

RequestedDrawing N/A

N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing N/A

N/A

Event Arguments:RequestingDrawingLayerEventArgs