Table of Contents
ThinkGeo.MapSuite.Core.FileBitmapTileCache
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
This class is a concrete class inherits from BitmapTileCache. In this class, the tiles will be saved in disk and can be viewed very conveniently.
Inheritance Hierarchy
- System.Object
- ThinkGeo.MapSuite.Core.TileCache
- ThinkGeo.MapSuite.Core.BitmapTileCache
- ThinkGeo.MapSuite.Core.FileBitmapTileCache
Members Summary
Public Constructors
FileBitmapTileCache()
- This is the default constructor.
Remarks
- If you use this constructor, you have to set the properties manually.
Parameters
FileBitmapTileCache(String)
- This is the overloads constructor.
Remarks
- If you use this constructor, the other properties are set with default values.
Parameters
- cacheDirectory
- Type:String
- Description:This parameter specifies the cache directory of the tile cache.
FileBitmapTileCache(String,String)
- This is the overloads constructor.
Remarks
- If you use this constructor, the other properties are set with default values.
Parameters
- cacheDirectory
- Type:String
- Description:This parameter specifies the cache directory of the tile cache.
- cacheId
- Type:String
- Description:This parameter specifies the cache id of the tile cache.
FileBitmapTileCache(String,String,TileImageFormat,TileMatrix)
- This is the constructor with all the parameters needed passed in.
Remarks
- N/A
Parameters
- cacheDirectory
- Type:String
- Description:This parameter specifies the cache directory of the tile cache.
- cacheId
- Type:String
- Description:This parameter specifies the cache id of the tile cache.
- imageFormat
- Type:TileImageFormat
- Description:This parameter specifies the image format of the tile cahce.
- tileMatrix
- Type:TileMatrix
- Description:This parameter specifies the tile matrix of the tile cache.
Protected Constructors
Public Methods
ClearCache(TimeSpan)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- tileExpiration
- Type:TimeSpan
- Description:N/A
ClearCache(Double)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- maxSizeInMegabytes
- Type:Double
- Description:N/A
ClearCache(TimeSpan,Double)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- tileExpiration
- Type:TimeSpan
- Description:N/A
- maxSizeInMegabytes
- Type:Double
- Description:N/A
GetTileImageFileNames(RectangleShape)
- N/A
Remarks
- N/A
Return Value
- Type:Collection<String>
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:String
- Description:N/A
Parameters
- row
- Type:Int64
- Description:N/A
- column
- Type:Int64
- Description:N/A
GetTile(RectangleShape)
- N/A
Remarks
- N/A
Return Value
- Type:BitmapTile
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:BitmapTile
- Description:N/A
Parameters
- row
- Type:Int64
- Description:N/A
- column
- Type:Int64
- Description:N/A
GetTiles(RectangleShape)
- N/A
Remarks
- N/A
Return Value
- Type:Collection<BitmapTile>
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:BitmapTile
- Description:N/A
Parameters
- tileBoundingBox
- Type:RectangleShape
- Description:N/A
- tileScale
- Type:Double
- Description:N/A
SaveTile(Tile)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- bitmap
- Type:Bitmap
- Description:N/A
- bitmapExtent
- Type:RectangleShape
- Description:N/A
- saveContainedCellsOnly
- Type:Boolean
- Description:N/A
SaveTiles(Bitmap,RectangleShape)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- bitmap
- Type:Bitmap
- Description:N/A
- bitmapExtent
- Type:RectangleShape
- Description:N/A
DeleteTiles(RectangleShape)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
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
GetTileCore(Int64,Int64)
- This method returns the BitmapTile corresponding to passed in row and column.
Remarks
- N/A
Return Value
- Type:BitmapTile
- Description:Returns the BitmapTile corresponding to the passed in row and column.
Parameters
- row
- Type:Int64
- Description:The target row for the tile to fetch.
- column
- Type:Int64
- Description:The target column for the tile to fetch.
SaveTileCore(Tile)
- This method will save the target tile passed in, you could override this API to create your own logic.
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- tile
- Type:Tile
- Description:The target tile to be saved.
DeleteTileCore(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
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:Boolean
- Description:N/A
Parameters
- tileImageFileName
- Type:String
- Description:N/A
GetBinariesFromBitmap(Bitmap)
- N/A
Remarks
- N/A
Return Value
- Type:Byte[]
- Description:N/A
Parameters
- bitmap
- Type:Bitmap
- Description:N/A
ClearCacheCore()
- 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
- Type:Void
- Description:N/A
Parameters
GetHigherScaleTileCore(RectangleShape,Double)
- This method overrides the logic in its base class BitmapTileCache. This method will return the HigherScale BitmapTile which is always used for preview effects when ZoomIn or ZoomOut.
Remarks
- N/A
Return Value
- Type:BitmapTile
- Description:Returns the higher scale(higher zoomLevel) bitmap tile.
Parameters
- tileBoundingBox
- Type:RectangleShape
- Description:The parameter specifies the current tile bounding box.
- tileScale
- Type:Double
- Description:This parameter specifies the current tile scale.
MergeBitmaps(IEnumerable<BitmapTile>,Double)
- N/A
Remarks
- N/A
Return Value
- Type:BitmapTile
- Description:N/A
Parameters
- tilesToMerge
- Type:IEnumerable<BitmapTile>
- Description:N/A
- scale
- Type:Double
- Description:N/A
OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- e
- Description:N/A
OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
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
GetEncoder(ImageFormat)
- N/A
Remarks
- N/A
Return Value
- Type:ImageCodecInfo
- Description:N/A
Parameters
- format
- Type:ImageFormat
- Description:N/A
GetTemporaryFolder()
- N/A
Remarks
- N/A
Return Value
- Type:String
- Description:N/A
Parameters
Public Properties
CacheDirectory
Gets or sets the cache direcory.
Remarks
N/A
Return Value
- Type:String
ExpirationTime
N/A
Remarks
N/A
Return Value
- Type:TimeSpan
TileMatrix
N/A
Remarks
N/A
Return Value
Remarks
N/A
Return Value
Remarks
N/A
Return Value
- Type:Bitmap
LoadingTileImage
N/A
Remarks
N/A
Return Value
- Type:Bitmap
ImageFormat
N/A
Remarks
N/A
Return Value
Remarks
N/A
Return Value
- Type:Int16
CacheId
N/A
Remarks
N/A
Return Value
- Type:String
Protected Properties
Public Events
GottenCacheImage
N/A
Remarks
Remarks
N/A
Event Arguments:GettingCacheImageBitmapTileCacheEventArgs