User Tools

Site Tools


api:thinkgeo.mapsuite.layers.heatlayer

ThinkGeo.MapSuite.Layers.HeatLayer

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Layers.Layer
      • ThinkGeo.MapSuite.Layers.HeatLayer

Members Summary

Public Constructors

HeatLayer()

  • This is the default constructor of the class.
Remarks
  • N/A
Parameters

HeatLayer(FeatureSource)

  • This is a constructor for the class.
Remarks
  • None
Parameters
  • featureSource
    • Description:This parameter is the FeatureSource that use to be drawn.

Protected Constructors

Public Methods

GetThreadSafetyLevel()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeep()

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

Open()

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

Close()

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

GetBoundingBox()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Draw(GeoCanvas,Collection<SimpleCandidate>)

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

RequestDrawing()

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

RequestDrawing(RectangleShape)

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

RequestDrawing(IEnumerable<RectangleShape>)

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

RequestDrawing(TimeSpan)

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

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

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

RequestDrawing(RectangleShape,TimeSpan)

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

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

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

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

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

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

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

ToString()

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

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

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

GetType()

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

Protected Methods

OpenCore()

  • N/A
Remarks
  • 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.
Return Value
  • Type:Void
  • Description:None
Parameters

CloseCore()

  • N/A
Remarks
  • 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.
Return Value
  • Type:Void
  • Description:None
Parameters

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

  • N/A
Remarks
  • 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.
Return Value
  • Type:Void
  • Description:None
Parameters
  • 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.

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

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

GetThreadSafetyLevelCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeepCore()

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

GetBoundingBoxCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

DrawException(GeoCanvas,Exception)

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

DrawExceptionCore(GeoCanvas,Exception)

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

OnDrawingException(DrawingExceptionLayerEventArgs)

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

OnDrawnException(DrawnExceptionLayerEventArgs)

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

DrawAttributionCore(GeoCanvas,String)

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

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

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

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

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

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

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

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

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

Finalize()

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

MemberwiseClone()

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

Public Properties

FeatureSource

  • N/A
Remarks
  • The FeatureSource is the provider of data to the HeatLayer. There are different FeatureSource classes to match the various ways that feature data is stored. It is important that, when you inherit from the HeatLayer, in the constructor you set the FeatureSource you want to use.
Return Value

HeatStyle

  • N/A
Remarks
  • If this property is not set, it will use the default HeatStyle.
Return Value

UpperScale

  • N/A
Remarks
  • The HeatLayer only displays when the currentScale is less than or equal to UpperScale and greater than or equal to LowerScale, otherwise it won't show anything.
Return Value
  • Type:Double

LowerScale

  • N/A
Remarks
  • The HeatLayer only displays when the currentScale is less than or equal to UpperScale and greater than or equal to LowerScale, otherwise it won't show anything.
Return Value
  • Type:Double

IsOpen

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

HasBoundingBox

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

DrawingTime

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

Name

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

Attribution

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

IsVisible

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Transparency

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

BlueTranslation

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

RedTranslation

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

GreenTranslation

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

KeyColors

  • N/A
Remarks
  • N/A
Return Value

IsNegative

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsGrayscale

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

ColorMappings

  • N/A
Remarks
  • N/A
Return Value

DrawingExceptionMode

  • N/A
Remarks
  • N/A
Return Value

RequestDrawingInterval

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

Protected Properties

StatusChanged

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsOpenCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Public Events

DrawingProgressChanged

  • N/A
Remarks
  • N/A

Event Arguments:DrawingProgressChangedEventArgs

DrawingException

  • N/A
Remarks
  • N/A

Event Arguments:DrawingExceptionLayerEventArgs

DrawnException

  • N/A
Remarks
  • N/A

Event Arguments:DrawnExceptionLayerEventArgs

DrawingAttribution

  • N/A
Remarks
  • N/A

Event Arguments:DrawingAttributionLayerEventArgs

DrawnAttribution

  • N/A
Remarks
  • N/A

Event Arguments:DrawnAttributionLayerEventArgs

RequestedDrawing

  • N/A
Remarks
  • N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing

  • N/A
Remarks
  • N/A

Event Arguments:RequestingDrawingLayerEventArgs

api/thinkgeo.mapsuite.layers.heatlayer.txt · Last modified: 2017/01/11 06:53 (external edit)