ThinkGeoCloudVectorMapsLayer¶
Namespace: ThinkGeo.Core.Async
ThinkGeoCloudVectorMapsLayer
public class ThinkGeoCloudVectorMapsLayer : WebBasedLayer
Inheritance Object → LayerBase → Layer → LayerAsync → WebBasedLayer → ThinkGeoCloudVectorMapsLayer
Properties¶
ShowDebugInfo¶
public bool ShowDebugInfo { get; set; }
Property Value¶
TileSize¶
public int TileSize { get; set; }
Property Value¶
ClientId¶
Gets or sets the client identifier.
public string ClientId { get; set; }
Property Value¶
The client identifier.
ClientSecret¶
Gets or sets the client secret.
public string ClientSecret { get; set; }
Property Value¶
The client secret.
MapType¶
Gets or sets the type of the map.
public ThinkGeoCloudVectorMapsMapType MapType { get; set; }
Property Value¶
ThinkGeoCloudVectorMapsMapType
The type of the map.
VectorTileCache¶
Gets or sets the vector tileView cache.
public FileVectorTileCache VectorTileCache { get; set; }
Property Value¶
The vector tileView cache.
BitmapTileCache¶
Gets or sets the bitmap tileView cache.
public RasterTileCache BitmapTileCache { get; set; }
Property Value¶
The bitmap tileView cache.
StyleJsonUri¶
Gets or sets the style json URI.
public Uri StyleJsonUri { get; set; }
Property Value¶
Uri
The style json URI.
ProjectionConverter¶
public ProjectionConverter ProjectionConverter { get; set; }
Property Value¶
WebProxy¶
public IWebProxy WebProxy { get; set; }
Property Value¶
IWebProxy
TimeoutInSeconds¶
public int TimeoutInSeconds { get; set; }
Property Value¶
Credentials¶
This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication.
public ICredentials Credentials { get; set; }
Property Value¶
ICredentials
UserAgent¶
This property allows you to specify a custom user-agent request header when making requests to a Web server. This header provides information about the client application or device and can be useful for server-side logging and analytics.
public string UserAgent { get; set; }
Property Value¶
UpperThreshold¶
This property gets and sets the upper threshold in the scale at which to display the image.
public double UpperThreshold { get; set; }
Property Value¶
Double
This property gets the upper threshold in the scale at which to display the image.
Remarks:
Above the upper threshold in scale, the image will not be displayed. This, in conjunction with the LowerThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is 0. This means the image should always display.
LowerThreshold¶
This property gets and sets the lower threshold in the scale at which to display the image.
public double LowerThreshold { get; set; }
Property Value¶
Double
This property gets the lower threshold in the scale at which to display the image.
Remarks:
Below the lower threshold in scale, the image will not be displayed. This, in conjunction with the UpperThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is 0. This means the image should always display.
Attribution¶
public string Attribution { get; set; }
Property Value¶
RequestDrawingInterval¶
public TimeSpan RequestDrawingInterval { get; set; }
Property Value¶
Name¶
This property gets and sets the name for the layer.
public string Name { get; set; }
Property Value¶
Remarks:
The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.
IsOpen¶
This property returns true if the Layer is open and false if it is not.
public bool IsOpen { get; }
Property Value¶
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¶
This property gets and set the visible state of the layer.
public bool IsVisible { get; set; }
Property Value¶
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¶
This property gets the last drawing time for the layer.
public TimeSpan DrawingTime { get; protected set; }
Property Value¶
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¶
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
Background¶
Gets and sets the background of the layer.
public GeoColor Background { get; set; }
Property Value¶
Transparency¶
This property gets and sets the amount of transparency to apply to the image.
public float Transparency { get; set; }
Property Value¶
Single
This property gets the amount of transparency to apply to the image.
Remarks:
None
BlueTranslation¶
This property gets and sets the amount of blue to apply to the image.
public float BlueTranslation { get; set; }
Property Value¶
Single
This property gets the amount of blue to apply to the image.
Remarks:
None
RedTranslation¶
This property gets and sets the amount of red to apply to the image.
public float RedTranslation { get; set; }
Property Value¶
Single
This property gets the amount of red to apply to the image.
Remarks:
None
GreenTranslation¶
This property gets and sets the amount of green to apply to the image.
public float GreenTranslation { get; set; }
Property Value¶
Single
This property gets the amount of green to apply to the image.
Remarks:
None
KeyColors¶
Gets a value represents a collection of key colors. If SupportKeyColor property is false, it will throw exception when you use KeyColors.
public Collection<GeoColor> KeyColors { get; }
Property Value¶
Remarks:
It will make these colors transparent when draw image.
IsNegative¶
This property gets and sets whether the image should be converted to negative (inverse colors).
public bool IsNegative { get; set; }
Property Value¶
Boolean
This property gets and sets whether the image should be converted to negative (inverse colors).
Remarks:
None
IsGrayscale¶
This property gets and sets if the image should be converted to grayscale.
public bool IsGrayscale { get; set; }
Property Value¶
This property gets and sets if the image should be converted to grayscale.
Remarks:
None
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.
public bool HasBoundingBox { get; }
Property Value¶
Remarks:
The default value is false.
ThreadSafe¶
public ThreadSafetyLevel ThreadSafe { get; set; }
Property Value¶
ColorMappings¶
ColorMapping
public Dictionary<GeoColor, GeoColor> ColorMappings { get; }
Property Value¶
Dictionary<GeoColor, GeoColor>
WrappingMode¶
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingExtent¶
public RectangleShape WrappingExtent { get; set; }
Property Value¶
Constructors¶
ThinkGeoCloudVectorMapsLayer()¶
Initializes a new instance of the ThinkGeoCloudVectorMapsLayer class.
public ThinkGeoCloudVectorMapsLayer()
Remarks:
This is a constructor for this class.
ThinkGeoCloudVectorMapsLayer(String, String)¶
Initializes a new instance of the ThinkGeoCloudVectorMapsLayer class.
public ThinkGeoCloudVectorMapsLayer(string clientId, string clientSecret)
Parameters¶
clientId
String
The client identifier.
clientSecret
String
The client secret.
ThinkGeoCloudVectorMapsLayer(String, String, Uri)¶
Initializes a new instance of the class.
public ThinkGeoCloudVectorMapsLayer(string clientId, string clientSecret, Uri styleJsonUri)
Parameters¶
clientId
String
The client identifier.
clientSecret
String
The client secret.
styleJsonUri
Uri
The style json URI.
ThinkGeoCloudVectorMapsLayer(String, String, ThinkGeoCloudVectorMapsMapType)¶
Initializes a new instance of the class.
public ThinkGeoCloudVectorMapsLayer(string clientId, string clientSecret, ThinkGeoCloudVectorMapsMapType mapType)
Parameters¶
clientId
String
The client identifier.
clientSecret
String
The client secret.
mapType
ThinkGeoCloudVectorMapsMapType
Type of the map.
Methods¶
OpenAsyncCore(CancellationToken)¶
protected Task OpenAsyncCore(CancellationToken cancellationToken)
Parameters¶
cancellationToken
CancellationToken
Returns¶
CloseAsyncCore(CancellationToken)¶
protected Task CloseAsyncCore(CancellationToken cancellationToken)
Parameters¶
cancellationToken
CancellationToken
Returns¶
DrawTileAsync(GeoCanvas, Int32, Int64, Int64)¶
public Task DrawTileAsync(GeoCanvas canvas, int zoomIndex, long columnIndex, long rowIndex)
Parameters¶
canvas
GeoCanvas
zoomIndex
Int32
columnIndex
Int64
rowIndex
Int64
Returns¶
DrawAsyncCore(GeoCanvas, Collection<SimpleCandidate>)¶
protected Task DrawAsyncCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)
Parameters¶
canvas
GeoCanvas
labelsInAllLayers
Collection<SimpleCandidate>
Returns¶
Events¶
SendingHttpRequest¶
public event EventHandler<SendingHttpRequestMessageEventArgs> SendingHttpRequest;
ReceivedHttpResponse¶
public event EventHandler<ReceivedHttpResponseMessageEventArgs> ReceivedHttpResponse;
DrawingAttribution¶
public event EventHandler<DrawingAttributionLayerEventArgs> DrawingAttribution;
DrawnAttribution¶
public event EventHandler<DrawnAttributionLayerEventArgs> DrawnAttribution;
DrawingProgressChanged¶
public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;
RequestedDrawing¶
public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;
RequestingDrawing¶
public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;
DrawingException¶
public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;
DrawnException¶
public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;