GridIsoLineLayer¶
Namespace: ThinkGeo.Core
Represents the GridIsoLineLayer class.
public class GridIsoLineLayer : IsoLineLayer
Inheritance object → LayerBase → Layer → IsoLineLayer → GridIsoLineLayer
Properties¶
GridPathFilename¶
Gets or sets the GridPathFilename.
public string GridPathFilename { get; set; }
Property Value¶
NoDataValue¶
Gets or sets the NoDataValue.
public double NoDataValue { get; set; }
Property Value¶
UpperScale¶
Gets or sets the UpperScale.
public double UpperScale { get; set; }
Property Value¶
LowerScale¶
Gets or sets the LowerScale.
public double LowerScale { get; set; }
Property Value¶
CustomStyles¶
Gets or sets the CustomStyles.
public Collection<Style> CustomStyles { get; }
Property Value¶
DataValueColumnName¶
Gets or sets the DataValueColumnName.
public string DataValueColumnName { get; set; }
Property Value¶
IsoLineLevels¶
Gets or sets the IsoLineLevels.
public Collection<double> IsoLineLevels { get; set; }
Property Value¶
IsoLineType¶
Gets or sets the IsoLineType.
public IsoLineType IsoLineType { get; set; }
Property Value¶
RequestDrawingInterval¶
Gets or sets the interval between automatic draw requests. Obsolete.
public TimeSpan RequestDrawingInterval { get; set; }
Property Value¶
Name¶
Gets or sets the display name for the layer.
public string Name { get; set; }
Property Value¶
string
The name used to identify the layer within UI components such as legends.
Remarks:
The name is user defined. Assign a descriptive value so tooling such as legends and layer lists can surface a meaningful label to end users.
IsOpen¶
Gets a value indicating whether the layer is currently open.
public bool IsOpen { get; }
Property Value¶
bool
true if the layer has completed its open routine; otherwise, false.
Remarks:
This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.
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.
IsVisible¶
Gets or sets a value indicating whether the layer is visible.
public bool IsVisible { get; set; }
Property Value¶
bool
true to draw the layer; otherwise, false.
Remarks:
If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers.
DrawingTime¶
Gets the last recorded drawing time for the layer.
public TimeSpan DrawingTime { get; protected set; }
Property Value¶
TimeSpan
The duration of the most recent draw operation.
Remarks:
We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.
Projection¶
Gets the projection of the layer.
public Projection Projection { get; set; }
Property Value¶
DrawingExceptionMode¶
Gets or sets how drawing exceptions are handled when the layer renders.
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
Background¶
Gets or sets the background color used when rendering the layer.
public GeoColor Background { get; set; }
Property Value¶
GeoColor
The fill applied to areas not covered by layer content.
Transparency¶
Gets or sets the amount of transparency applied to the rendered image.
public float Transparency { get; set; }
Property Value¶
float
A value between 0 (fully transparent) and 255 (fully opaque).
BlueTranslation¶
Gets or sets the intensity adjustment applied to the blue channel.
public float BlueTranslation { get; set; }
Property Value¶
float
A value between -255 and 255 representing the blue channel translation.
RedTranslation¶
Gets or sets the intensity adjustment applied to the red channel.
public float RedTranslation { get; set; }
Property Value¶
float
A value between -255 and 255 representing the red channel translation.
GreenTranslation¶
Gets or sets the intensity adjustment applied to the green channel.
public float GreenTranslation { get; set; }
Property Value¶
float
A value between -255 and 255 representing the green channel translation.
KeyColors¶
Gets the collection of key colors that should be rendered as transparent.
public Collection<GeoColor> KeyColors { get; }
Property Value¶
Remarks:
Attempting to access this collection when the associated GeoCanvas does not support key colors (see GeoCanvas.SupportKeyColor) results in an exception. Add colors to this collection to ensure they render as transparent.
IsNegative¶
Gets or sets a value indicating whether the image should be rendered with inverted colors.
public bool IsNegative { get; set; }
Property Value¶
bool
true to invert the color channels; otherwise, false.
IsGrayscale¶
Gets or sets a value indicating whether the image should be converted to grayscale prior to rendering.
public bool IsGrayscale { get; set; }
Property Value¶
bool
true to apply a grayscale filter; otherwise, false.
HasBoundingBox¶
Gets a value indicating whether the layer supports retrieving its bounding box.
public bool HasBoundingBox { get; }
Property Value¶
Remarks:
When this property is false, calls to or GetFullExtent throw an exception. The default implementation returns false.
ThreadSafe¶
Gets or sets the threading guarantees provided by the layer implementation.
public ThreadSafetyLevel ThreadSafe { get; set; }
Property Value¶
ThreadSafetyLevel
The level of thread safety that callers can expect when interacting with the layer.
ColorMappings¶
Gets the color translation map that will be applied when rendering the layer.
public Dictionary<GeoColor, GeoColor> ColorMappings { get; }
Property Value¶
Dictionary<GeoColor, GeoColor>
WrappingMode¶
Gets or sets how the layer wraps when the map extent crosses world boundaries.
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingExtent¶
Gets or sets the geographic extent to use when wrapping is enabled.
public RectangleShape WrappingExtent { get; set; }
Property Value¶
Constructors¶
GridIsoLineLayer()¶
Initializes a new instance of the GridIsoLineLayer class.
public GridIsoLineLayer()
GridIsoLineLayer(string)¶
Initializes a new instance of the GridIsoLineLayer class.
public GridIsoLineLayer(string gridPathFilename)
Parameters¶
gridPathFilename string
GridIsoLineLayer(string, IEnumerable<double>)¶
Initializes a new instance of the GridIsoLineLayer class.
public GridIsoLineLayer(string gridPathFilename, IEnumerable<double> isoLineLevels)
Parameters¶
gridPathFilename string
isoLineLevels IEnumerable<double>
GridIsoLineLayer(string, IEnumerable<double>, double, double)¶
Initializes a new instance of the GridIsoLineLayer class.
public GridIsoLineLayer(string gridPathFilename, IEnumerable<double> isoLineLevels, double lowerScale, double upperScale)
Parameters¶
gridPathFilename string
isoLineLevels IEnumerable<double>
lowerScale double
upperScale double
GridIsoLineLayer(string, IEnumerable<double>, double, double, IsoLineType)¶
Initializes a new instance of the GridIsoLineLayer class.
public GridIsoLineLayer(string gridPathFilename, IEnumerable<double> isoLineLevels, double lowerScale, double upperScale, IsoLineType isoLineType)
Parameters¶
gridPathFilename string
isoLineLevels IEnumerable<double>
lowerScale double
upperScale double
isoLineType IsoLineType
Methods¶
OpenCore()¶
Provides the overridable implementation that opens the instance and initializes the resources it depends on.
protected void OpenCore()
Returns¶
GetIsoLineFeatures()¶
Returns iso line features from the underlying data source.
public Collection<Feature> GetIsoLineFeatures()
Returns¶
Collection<Feature>
The result of the operation.
OnStreamLoading(StreamLoadingEventArgs)¶
Performs on stream loading.
protected void OnStreamLoading(StreamLoadingEventArgs e)
Parameters¶
e StreamLoadingEventArgs
The stream to read from or write to.
Returns¶
GetFeaturesForDrawingCore(GeoCanvas, Collection<SimpleCandidate>)¶
Provides the overridable implementation that returns the set of features that should be used for drawing on the specified canvas.
protected Collection<Feature> GetFeaturesForDrawingCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)
Parameters¶
canvas GeoCanvas
The to draw to.
labelsInAllLayers Collection<SimpleCandidate>
A shared collection that receives label candidates generated during drawing.
Returns¶
Collection<Feature>
The result of the operation.
Events¶
StreamLoading¶
Occurs when the StreamLoading event is raised.
public event EventHandler<StreamLoadingEventArgs> StreamLoading;
DrawingProgressChanged¶
Occurs as the layer reports drawing progress (useful for async or tiled rendering scenarios).
public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;
RequestedDrawing¶
Raised after the drawing buffer elapses so consumers can handle a legacy drawing cycle. Obsolete.
public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;
RequestingDrawing¶
Raised before the drawing buffer elapses so consumers can cancel a legacy drawing operation. Obsolete.
public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;
DrawingException¶
Occurs when the DrawingException event is raised.
public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;
DrawnException¶
Occurs when the DrawnException event is raised.
public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;