Products
Professional Services
Demos and Downloads
Help and Support
Sidebar
thinkgeo.mapsuite.core.bitmaptilecache
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.Core.BitmapTileCache
<!– Class –> This is the base class for BitmapTileCache system which inherits from TileCache class.
Remarks
TileCahce system is very efficient in improving the performance of application, especially when large data or remote server images are included.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.Core.TileCache *ThinkGeo.MapSuite.Core.BitmapTileCache ThinkGeo.MapSuite.Core.EncryptedFileBitmapTileCache ThinkGeo.MapSuite.Core.FileBitmapTileCache ThinkGeo.MapSuite.Core.InMemoryBitmapTileCache
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 BitmapTileCache | String, TileImageFormat, TileMatrix | This is the constructor of the class. |
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 ClearCache | TileCache | This method will clear all the tiles in the tileCache. | |
| DeleteTile | Tile | TileCache | This method will delete the target tile passed in. |
| DeleteTiles | RectangleShape | TileCache | This method will delete the tiles within the passed in worldExtent. |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetHigherScaleTile | RectangleShape, Double | This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut. | |
| GetTile | RectangleShape | This method returns the BitmapTile corresponding to the tile bounding box passed in. | |
| GetTile | Int64, Int64 | This method returns the BitmapTile corresponding to passed in row and column. | |
| GetTiles | RectangleShape | This method returns all the BitmapTiles within the passed in world extent, some of which may not has bitmap. | |
| GetType | Object | ||
| SaveTile | Tile | TileCache | This method will save the target tile passed in. |
| SaveTiles | Bitmap, RectangleShape, Boolean | TileCache | |
| SaveTiles | Bitmap, RectangleShape | TileCache | This method will save the bitmap with its extent attached into tiles. |
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| ClearCacheCore | TileCache | This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method. | |
| DeleteTileCore | Tile | TileCache | This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method. |
| Finalize | Object | ||
| GetHigherScaleTileCore | RectangleShape, Double | This method is virtual and can be overriden by its sub classes. This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut. | |
| GetTileCore | Int64, Int64 | This abstract method returns the BitmapTile corresponding to passed in row and column. Each concrete TileCache need to implement this logic to get tile from a row and column. | |
| MemberwiseClone | Object | ||
| MergeBitmaps | IEnumerable<BitmapTile>, Double | This method will merege the passed in bitmap tiles into a larege bitmap tile. | |
| OnGettingCacheImage | GettingCacheImageBitmapTileCacheEventArgs | ||
| OnGottenCacheImage | GottenCacheImageBitmapTileCacheEventArgs | ||
| SaveTileCore | Tile | TileCache | This abstract method will save the target tile passed in, for each sub TileCache class must implement this method. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 CacheId | String | TileCache | Gets or sets the id of the TileCache. |
| ImageFormat | TileImageFormat | TileCache | Gets or sets the tile image format. |
| JpegQuality | Int16 | TileCache | Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg. |
| LoadingTileImage | Bitmap | TileCache | This property returns back a preset image showing the Tile is loading. |
| NoDataTileImage | Bitmap | TileCache | This property returns back a preset image showing the tile data is missing. |
| TileAccessMode | TileAccessMode | TileCache | Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete |
| TileMatrix | TileMatrix | TileCache | Gets or sets the TileMatrix which is used in caculation for tiles. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 GettingCacheImage | GettingCacheImageBitmapTileCacheEventArgs | ||
| GottenCacheImage | GottenCacheImageBitmapTileCacheEventArgs |
Public Constructors
Protected Constructors
BitmapTileCache(String, TileImageFormat, TileMatrix)
This is the constructor of the class.
Parameters
| Name | Type | Description |
|---|---|---|
| cacheId | String<!– System.String –> | This is the cache identifier which marks its difference with other TileCache. |
| imageFormat | TileImageFormat<!– ThinkGeo.MapSuite.Core.TileImageFormat –> | This is the imageFormate showing what kind of image we are trying to save. |
| tileMatrix | TileMatrix<!– ThinkGeo.MapSuite.Core.TileMatrix –> | This is the tile matrix system which is used for caculating tiles. |
Public Methods
ClearCache()
This method will clear all the tiles in the tileCache.
Remarks
This method will not take effect when the ReadOnly is set to true.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
DeleteTile(Tile)
This method will delete the target tile passed in.
Remarks
This method will not take effect when the ReadOnly is set to true.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| tile | Tile<!– ThinkGeo.MapSuite.Core.Tile –> | The target tile to be deleted. |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
DeleteTiles(RectangleShape)
This method will delete the tiles within the passed in worldExtent.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| worldExtent | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | The target extent to delete all tiles within it. |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetHigherScaleTile(RectangleShape, Double)
This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut.
Return Value
| Return Type | Description |
|---|---|
| BitmapTile<!– ThinkGeo.MapSuite.Core.BitmapTile –> | Returns the higher scale(higher zoomLevel) bitmap tile. |
Parameters
| Name | Type | Description |
|---|---|---|
| tileBoundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | The parameter specifies the current tile bounding box. |
| tileScale | Double<!– System.Double –> | This parameter specifies the current tile scale. |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
GetTile(RectangleShape)
This method returns the BitmapTile corresponding to the tile bounding box passed in.
Return Value
| Return Type | Description |
|---|---|
| BitmapTile<!– ThinkGeo.MapSuite.Core.BitmapTile –> | Returns the BitmapTile corresponding to the passed in boundingBox. |
Parameters
| Name | Type | Description |
|---|---|---|
| tileBoundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | The target boundingBox for the tile to fetch. |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
GetTile(Int64, Int64)
This method returns the BitmapTile corresponding to passed in row and column.
Return Value
| Return Type | Description |
|---|---|
| BitmapTile<!– ThinkGeo.MapSuite.Core.BitmapTile –> | Returns the BitmapTile corresponding to the passed in row and column. |
Parameters
| Name | Type | Description |
|---|---|---|
| row | Int64<!– System.Int64 –> | The target row for the tile to fetch. |
| column | Int64<!– System.Int64 –> | The target column for the tile to fetch. |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
GetTiles(RectangleShape)
This method returns all the BitmapTiles within the passed in world extent, some of which may not has bitmap.
Return Value
| Return Type | Description |
|---|---|
| Collection<BitmapTile><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.BitmapTile} –> | Returns a collection of BitmapTiles within the passed in worldExtent. |
Parameters
| Name | Type | Description |
|---|---|---|
| worldExtent | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | The target worldExtent will be used to fetch all the BitmapTiles from. |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
SaveTile(Tile)
This method will save the target tile passed in.
Remarks
This method will not take effect when the ReadOnly is set to true.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| tile | Tile<!– ThinkGeo.MapSuite.Core.Tile –> | The target tile to be saved. |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
SaveTiles(Bitmap, RectangleShape, Boolean)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| bitmap | Bitmap<!– System.Drawing.Bitmap –> | |
| bitmapExtent | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| saveContainedCellsOnly | Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
SaveTiles(Bitmap, RectangleShape)
This method will save the bitmap with its extent attached into tiles.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| bitmap | Bitmap<!– System.Drawing.Bitmap –> | The target bitmap to be saved into tiles. |
| bitmapExtent | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | The target extent for the bitmap. |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
ClearCacheCore()
This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method.
Remarks
This method will not take effect when the ReadOnly is set to true.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
DeleteTileCore(Tile)
This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method.
Remarks
This method will not take effect when the ReadOnly is set to true.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| tile | Tile<!– ThinkGeo.MapSuite.Core.Tile –> | The target tile to be deleted. |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetHigherScaleTileCore(RectangleShape, Double)
This method is virtual and can be overriden by its sub classes. This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut.
Return Value
| Return Type | Description |
|---|---|
| BitmapTile<!– ThinkGeo.MapSuite.Core.BitmapTile –> | Returns the higher scale(higher zoomLevel) bitmap tile. |
Parameters
| Name | Type | Description |
|---|---|---|
| tileBoundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | The parameter specifies the current tile bounding box. |
| tileScale | Double<!– System.Double –> | This parameter specifies the current tile scale. |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
GetTileCore(Int64, Int64)
This abstract method returns the BitmapTile corresponding to passed in row and column. Each concrete TileCache need to implement this logic to get tile from a row and column.
Return Value
| Return Type | Description |
|---|---|
| BitmapTile<!– ThinkGeo.MapSuite.Core.BitmapTile –> | Returns the BitmapTile corresponding to the passed in row and column. |
Parameters
| Name | Type | Description |
|---|---|---|
| row | Int64<!– System.Int64 –> | The target row for the tile to fetch. |
| column | Int64<!– System.Int64 –> | The target column for the tile to fetch. |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
MergeBitmaps(IEnumerable<BitmapTile>, Double)
This method will merege the passed in bitmap tiles into a larege bitmap tile.
Return Value
| Return Type | Description |
|---|---|
| BitmapTile<!– ThinkGeo.MapSuite.Core.BitmapTile –> | Returns a merged bitmap tile. |
Parameters
| Name | Type | Description |
|---|---|---|
| tilesToMerge | IEnumerable<BitmapTile><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.BitmapTile} –> | The collection of tiles to be mereged. |
| scale | Double<!– System.Double –> | The target scale for result mereged bitmap tile. |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | GettingCacheImageBitmapTileCacheEventArgs<!– ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs –> |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | GottenCacheImageBitmapTileCacheEventArgs<!– ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs –> |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
SaveTileCore(Tile)
This abstract method will save the target tile passed in, for each sub TileCache class must implement this method.
Remarks
This method will not take effect when the ReadOnly is set to true.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| tile | Tile<!– ThinkGeo.MapSuite.Core.Tile –> | The target tile to be saved. |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
Public Properties
CacheId
Gets or sets the id of the TileCache.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
ImageFormat
Gets or sets the tile image format.
Return Value
| Return Type |
|---|
| TileImageFormat<!– ThinkGeo.MapSuite.Core.TileImageFormat –> |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
JpegQuality
Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.
Return Value
| Return Type |
|---|
| Int16<!– System.Int16 –> |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
LoadingTileImage
This property returns back a preset image showing the Tile is loading.
Return Value
| Return Type |
|---|
| Bitmap<!– System.Drawing.Bitmap –> |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
NoDataTileImage
This property returns back a preset image showing the tile data is missing.
Return Value
| Return Type |
|---|
| Bitmap<!– System.Drawing.Bitmap –> |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
TileAccessMode
Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete
Remarks
If you want it to take effect, you need set the ReadOnly property false.
Return Value
| Return Type |
|---|
| TileAccessMode<!– ThinkGeo.MapSuite.Core.TileAccessMode –> |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
TileMatrix
Gets or sets the TileMatrix which is used in caculation for tiles.
Return Value
| Return Type |
|---|
| TileMatrix<!– ThinkGeo.MapSuite.Core.TileMatrix –> |
<!– ThinkGeo.MapSuite.Core.TileCache –> Go Back
Protected Properties
Public Events
GettingCacheImage
Event Arguments
| Event Arguments |
|---|
| GettingCacheImageBitmapTileCacheEventArgs<!– ThinkGeo.MapSuite.Core.GettingCacheImageBitmapTileCacheEventArgs –> |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
GottenCacheImage
Event Arguments
| Event Arguments |
|---|
| GottenCacheImageBitmapTileCacheEventArgs<!– ThinkGeo.MapSuite.Core.GottenCacheImageBitmapTileCacheEventArgs –> |
<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> Go Back
NOTOC MapSuiteCore ThinkGeo.MapSuite.Core UpdateDocumentation
thinkgeo.mapsuite.core.bitmaptilecache.1440040128.txt.gz · Last modified: 2015/09/17 08:56 (external edit)
