ThinkGeoMBTilesLayer¶
Namespace: ThinkGeo.Core
public class ThinkGeoMBTilesLayer : Layer
Inheritance Object → Layer → ThinkGeoMBTilesLayer
Properties¶
ProjectionConverter¶
public ProjectionConverter ProjectionConverter { get; set; }
Property Value¶
BitmapTileCache¶
public RasterTileCache BitmapTileCache { get; set; }
Property Value¶
StyleJsonUri¶
public Uri StyleJsonUri { get; set; }
Property Value¶
Uri
DrawingQuality¶
public DrawingQuality DrawingQuality { get; set; }
Property Value¶
ShowDebugInfo¶
public bool ShowDebugInfo { get; set; }
Property Value¶
TileSize¶
public int TileSize { get; set; }
Property Value¶
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.
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.
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.
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.
Attribution¶
public string Attribution { get; set; }
Property Value¶
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.
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
ColorMappings¶
ColorMapping
public Dictionary<GeoColor, GeoColor> ColorMappings { get; }
Property Value¶
Dictionary<GeoColor, GeoColor>
DrawingExceptionMode¶
Gets or sets the DrawExceptionMode when exception happens.
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
ThreadSafe¶
public ThreadSafetyLevel ThreadSafe { get; set; }
Property Value¶
Projection¶
Gets the projection of the layer.
public Projection Projection { get; set; }
Property Value¶
Background¶
Gets and sets the background of the layer.
public GeoColor Background { get; set; }
Property Value¶
WrappingMode¶
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingExtent¶
public RectangleShape WrappingExtent { get; set; }
Property Value¶
RequestDrawingInterval¶
public TimeSpan RequestDrawingInterval { get; set; }
Property Value¶
Constructors¶
ThinkGeoMBTilesLayer()¶
public ThinkGeoMBTilesLayer()
ThinkGeoMBTilesLayer(String)¶
public ThinkGeoMBTilesLayer(string mbTilesPathFilename)
Parameters¶
mbTilesPathFilename
String
ThinkGeoMBTilesLayer(String, Uri)¶
public ThinkGeoMBTilesLayer(string mbTilesPathFilename, Uri styleJsonUri)
Parameters¶
mbTilesPathFilename
String
styleJsonUri
Uri
Methods¶
CloseCore()¶
protected void CloseCore()
OpenCore()¶
protected void OpenCore()
GetBoundingBoxCore()¶
protected RectangleShape GetBoundingBoxCore()
Returns¶
GetTile(Int64, Int64, Int64)¶
public VectorTile GetTile(long zoom, long column, long row)
Parameters¶
zoom
Int64
column
Int64
row
Int64
Returns¶
LoadStyleJson()¶
public void LoadStyleJson()
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¶
DrawTileAsync(GeoCanvas, Int32, Int64, Int64, ZoomLevelSet, Boolean, RasterTileCache, Int32, List<String>, GetFeaturesFromPbfVectorTileAsyncDelegate, Boolean, Int32)¶
internal static Task DrawTileAsync(GeoCanvas canvas, int zoomIndex, long columnIndex, long rowIndex, ZoomLevelSet zoomLevelSet, bool ShowDebugInfo, RasterTileCache BitmapTileCache, int maxZoom, List<string> pbfLayerNames, GetFeaturesFromPbfVectorTileAsyncDelegate getFeaturesFromPbfVectorTileAsyncDelegate, bool useLegacyLabeling, int tileSize)
Parameters¶
canvas
GeoCanvas
zoomIndex
Int32
columnIndex
Int64
rowIndex
Int64
zoomLevelSet
ZoomLevelSet
ShowDebugInfo
Boolean
BitmapTileCache
RasterTileCache
maxZoom
Int32
pbfLayerNames
List<String>
getFeaturesFromPbfVectorTileAsyncDelegate
GetFeaturesFromPbfVectorTileAsyncDelegate
useLegacyLabeling
Boolean
tileSize
Int32
Returns¶
GetFeaturesForDrawing(Int32, Int64, Int64, RectangleShape, CancellationToken, Int32, List<String>, GetFeaturesFromPbfVectorTileDelegate)¶
internal static Collection<Feature> GetFeaturesForDrawing(int zoom, long column, long row, RectangleShape boundingBox, CancellationToken cancellationToken, int maxZoom, List<string> pbfLayerNames, GetFeaturesFromPbfVectorTileDelegate getFeaturesFromPbfVectorTile)
Parameters¶
zoom
Int32
column
Int64
row
Int64
boundingBox
RectangleShape
cancellationToken
CancellationToken
maxZoom
Int32
pbfLayerNames
List<String>
getFeaturesFromPbfVectorTile
GetFeaturesFromPbfVectorTileDelegate
Returns¶
GetFeaturesForDrawingAsync(Int32, Int64, Int64, RectangleShape, CancellationToken, Int32, List<String>, GetFeaturesFromPbfVectorTileAsyncDelegate)¶
internal static Task<Collection<Feature>> GetFeaturesForDrawingAsync(int zoom, long column, long row, RectangleShape boundingBox, CancellationToken cancellationToken, int maxZoom, List<string> pbfLayerNames, GetFeaturesFromPbfVectorTileAsyncDelegate getFeaturesFromPbfVectorTileAsync)
Parameters¶
zoom
Int32
column
Int64
row
Int64
boundingBox
RectangleShape
cancellationToken
CancellationToken
maxZoom
Int32
pbfLayerNames
List<String>
getFeaturesFromPbfVectorTileAsync
GetFeaturesFromPbfVectorTileAsyncDelegate
Returns¶
GetPbfLayerNamesForRendering(ZoomLevelSet, Int32)¶
internal static List<string> GetPbfLayerNamesForRendering(ZoomLevelSet zoomLevelSet, int zoomLevelIndex)
Parameters¶
zoomLevelSet
ZoomLevelSet
zoomLevelIndex
Int32
Returns¶
DrawCore(GeoCanvas, Collection<SimpleCandidate>)¶
protected void DrawCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)
Parameters¶
canvas
GeoCanvas
labelsInAllLayers
Collection<SimpleCandidate>
OnGeneratingTile(GeneratingTileMBTilesLayerEventArgs)¶
protected void OnGeneratingTile(GeneratingTileMBTilesLayerEventArgs e)
Parameters¶
e
GeneratingTileMBTilesLayerEventArgs
OnGeneratedTile(GeneratedTileMBTilesLayerEventArgs)¶
protected void OnGeneratedTile(GeneratedTileMBTilesLayerEventArgs e)
Parameters¶
e
GeneratedTileMBTilesLayerEventArgs
BeginTransaction()¶
public void BeginTransaction()
CommitTransaction()¶
public TransactionResult CommitTransaction()
Returns¶
WriteMetaData(String, String)¶
public void WriteMetaData(string key, string value)
Parameters¶
key
String
value
String
CreateDatabase(String, Boolean)¶
public static void CreateDatabase(string mbTilesPath, bool isOverwrite)
Parameters¶
mbTilesPath
String
isOverwrite
Boolean
AddTile(VectorTile)¶
public void AddTile(VectorTile vectorTile)
Parameters¶
vectorTile
VectorTile
UpdateTile(VectorTile)¶
public void UpdateTile(VectorTile vectorTile)
Parameters¶
vectorTile
VectorTile
DeleteTile(VectorTile)¶
public void DeleteTile(VectorTile vectorTile)
Parameters¶
vectorTile
VectorTile
Events¶
GeneratingTile¶
public event EventHandler<GeneratingTileMBTilesLayerEventArgs> GeneratingTile;
GeneratedTile¶
public event EventHandler<GeneratedTileMBTilesLayerEventArgs> GeneratedTile;
DrawingProgressChanged¶
public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;
DrawingException¶
public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;
DrawnException¶
public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;
DrawingAttribution¶
public event EventHandler<DrawingAttributionLayerEventArgs> DrawingAttribution;
DrawnAttribution¶
public event EventHandler<DrawnAttributionLayerEventArgs> DrawnAttribution;
RequestedDrawing¶
public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;
RequestingDrawing¶
public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;