This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.filebitmaptilecache [2015/09/21 01:03] admin |
thinkgeo.mapsuite.core.filebitmaptilecache [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.FileBitmapTileCache ====== | ====== ThinkGeo.MapSuite.Core.FileBitmapTileCache ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| 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. | 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 ===== | ===== Inheritance Hierarchy ===== | ||
| Line 11: | Line 14: | ||
| ** {{wiki:PublicMethod.gif|}} FileBitmapTileCache() ** | ** {{wiki:PublicMethod.gif|}} FileBitmapTileCache() ** | ||
| - | This is the default constructor. | + | * //This is the default constructor.// |
| == Remarks == | == Remarks == | ||
| - | If you use this constructor, you have to set the properties manually. | + | * //If you use this constructor, you have to set the properties manually.// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} FileBitmapTileCache(String) ** | ** {{wiki:PublicMethod.gif|}} FileBitmapTileCache(String) ** | ||
| - | This is the overloads constructor. | + | * //This is the overloads constructor.// |
| == Remarks == | == Remarks == | ||
| - | If you use this constructor, the other properties are set with default values. | + | * //If you use this constructor, the other properties are set with default values.// |
| == Parameters == | == Parameters == | ||
| * //cacheDirectory// | * //cacheDirectory// | ||
| Line 29: | Line 32: | ||
| ** {{wiki:PublicMethod.gif|}} FileBitmapTileCache(String,String) ** | ** {{wiki:PublicMethod.gif|}} FileBitmapTileCache(String,String) ** | ||
| - | This is the overloads constructor. | + | * //This is the overloads constructor.// |
| == Remarks == | == Remarks == | ||
| - | If you use this constructor, the other properties are set with default values. | + | * //If you use this constructor, the other properties are set with default values.// |
| == Parameters == | == Parameters == | ||
| * //cacheDirectory// | * //cacheDirectory// | ||
| Line 44: | Line 47: | ||
| ** {{wiki:PublicMethod.gif|}} FileBitmapTileCache(String,String,TileImageFormat,TileMatrix) ** | ** {{wiki:PublicMethod.gif|}} FileBitmapTileCache(String,String,TileImageFormat,TileMatrix) ** | ||
| - | This is the constructor with all the parameters needed passed in. | + | * //This is the constructor with all the parameters needed passed in.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Parameters == | == Parameters == | ||
| * //cacheDirectory// | * //cacheDirectory// | ||
| Line 67: | Line 70: | ||
| ==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} GetTileImageFileName(Int64,Int64) ** | + | ** {{wiki:PublicMethod.gif|}} ClearCache(TimeSpan) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:String | + | * Type:Void |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //row// | + | * //tileExpiration// |
| - | * Type:Int64 | + | * Type:TimeSpan |
| * Description:N/A | * Description:N/A | ||
| - | * //column// | + | <div newline></div> |
| - | * Type:Int64 | + | ** {{wiki:PublicMethod.gif|}} ClearCache(Double) ** |
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //maxSizeInMegabytes// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} 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 | * Description:N/A | ||
| Line 89: | Line 124: | ||
| ** {{wiki:PublicMethod.gif|}} GetTileImageFileNames(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} GetTileImageFileNames(RectangleShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 100: | Line 135: | ||
| * //tileBoundingBox// | * //tileBoundingBox// | ||
| * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetTileImageFileName(Int64,Int64) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //row// | ||
| + | * Type:Int64 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //column// | ||
| + | * Type:Int64 | ||
| * Description:N/A | * Description:N/A | ||
| Line 105: | Line 160: | ||
| ** {{wiki:PublicMethod.gif|}} GetTile(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} GetTile(RectangleShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 121: | Line 176: | ||
| ** {{wiki:PublicMethod.gif|}} GetTile(Int64,Int64) ** | ** {{wiki:PublicMethod.gif|}} GetTile(Int64,Int64) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 141: | Line 196: | ||
| ** {{wiki:PublicMethod.gif|}} GetTiles(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} GetTiles(RectangleShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 157: | Line 212: | ||
| ** {{wiki:PublicMethod.gif|}} GetHigherScaleTile(RectangleShape,Double) ** | ** {{wiki:PublicMethod.gif|}} GetHigherScaleTile(RectangleShape,Double) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 177: | Line 232: | ||
| ** {{wiki:PublicMethod.gif|}} SaveTile(Tile) ** | ** {{wiki:PublicMethod.gif|}} SaveTile(Tile) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 191: | Line 246: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveTiles(GeoImage,RectangleShape) ** | + | ** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape,Boolean) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 203: | Line 258: | ||
| == Parameters == | == Parameters == | ||
| * //bitmap// | * //bitmap// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Bitmap |
| + | * Description:N/A | ||
| + | |||
| + | * //bitmapExtent// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //saveContainedCellsOnly// | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //bitmap// | ||
| + | * Type:Bitmap | ||
| * Description:N/A | * Description:N/A | ||
| Line 213: | Line 292: | ||
| ** {{wiki:PublicMethod.gif|}} DeleteTiles(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} DeleteTiles(RectangleShape) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 229: | Line 308: | ||
| ** {{wiki:PublicMethod.gif|}} DeleteTile(Tile) ** | ** {{wiki:PublicMethod.gif|}} DeleteTile(Tile) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 245: | Line 324: | ||
| ** {{wiki:PublicMethod.gif|}} ClearCache() ** | ** {{wiki:PublicMethod.gif|}} ClearCache() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 257: | Line 336: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 269: | Line 348: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 285: | Line 364: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 297: | Line 376: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 310: | Line 389: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetTileCore(Int64,Int64) ** | ** {{wiki:ProtectedMethod.gif|}} GetTileCore(Int64,Int64) ** | ||
| - | This method returns the BitmapTile corresponding to passed in row and column. | + | * //This method returns the BitmapTile corresponding to passed in row and column.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 330: | Line 409: | ||
| ** {{wiki:ProtectedMethod.gif|}} SaveTileCore(Tile) ** | ** {{wiki:ProtectedMethod.gif|}} SaveTileCore(Tile) ** | ||
| - | This method will save the target tile passed in, you could override this API to create your own logic. | + | * //This method will save the target tile passed in, you could override this API to create your own logic.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 346: | Line 425: | ||
| ** {{wiki:ProtectedMethod.gif|}} DeleteTileCore(Tile) ** | ** {{wiki:ProtectedMethod.gif|}} DeleteTileCore(Tile) ** | ||
| - | This method will delete the target tile passed in. | + | * //This method will delete the target tile passed in.// |
| == Remarks == | == Remarks == | ||
| - | This method will not take effect when the ReadOnly is set to true. | + | * //This method will not take effect when the ReadOnly is set to true.// |
| == Return Value == | == Return Value == | ||
| Line 360: | Line 439: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} zhs=(String) ** | + | ** {{wiki:ProtectedMethod.gif|}} CheckExpiration(String) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 371: | Line 450: | ||
| == Parameters == | == Parameters == | ||
| - | * //zxs=// | + | * //tileImageFileName// |
| * Type:String | * Type:String | ||
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 0Bs=(GeoImage) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetBinariesFromBitmap(Bitmap) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 387: | Line 466: | ||
| == Parameters == | == Parameters == | ||
| - | * //0Rs=// | + | * //bitmap// |
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Bitmap |
| * Description:N/A | * Description:N/A | ||
| Line 394: | Line 473: | ||
| ** {{wiki:ProtectedMethod.gif|}} ClearCacheCore() ** | ** {{wiki:ProtectedMethod.gif|}} ClearCacheCore() ** | ||
| - | This method will clear all the tiles in the tileCache. | + | * //This method will clear all the tiles in the tileCache.// |
| == Remarks == | == Remarks == | ||
| - | This method will not take effect when the ReadOnly is set to true. | + | * //This method will not take effect when the ReadOnly is set to true.// |
| == Return Value == | == Return Value == | ||
| Line 406: | Line 485: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetHigherScaleTileCore(RectangleShape,Double) ** | ** {{wiki:ProtectedMethod.gif|}} 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. | + | * //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 == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 426: | Line 505: | ||
| ** {{wiki:ProtectedMethod.gif|}} MergeBitmaps(IEnumerable<BitmapTile>,Double) ** | ** {{wiki:ProtectedMethod.gif|}} MergeBitmaps(IEnumerable<BitmapTile>,Double) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 446: | Line 525: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnGottenCacheImage(GottenCacheImageBitmapTileCacheEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 462: | Line 541: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnGettingCacheImage(GettingCacheImageBitmapTileCacheEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 478: | Line 557: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 490: | Line 569: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 500: | Line 579: | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} 0hs=(GeoImageFormat) ** | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} GetEncoder(ImageFormat) ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 511: | Line 590: | ||
| == Parameters == | == Parameters == | ||
| - | * //0xs=// | + | * //format// |
| - | * Type:[[ThinkGeo.MapSuite.Portable.GeoImageFormat|GeoImageFormat]] | + | * Type:ImageFormat |
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} 2hs=() ** | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} GetTemporaryFolder() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 567: | Line 646: | ||
| N/A | N/A | ||
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Bitmap |
| ** {{wiki:PublicProperty.gif|}} LoadingTileImage ** | ** {{wiki:PublicProperty.gif|}} LoadingTileImage ** | ||
| Line 575: | Line 654: | ||
| N/A | N/A | ||
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Bitmap |
| ** {{wiki:PublicProperty.gif|}} ImageFormat ** | ** {{wiki:PublicProperty.gif|}} ImageFormat ** | ||
| Line 602: | Line 681: | ||
| ==== Protected Properties ==== | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} yhs= ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| ==== Public Events ==== | ==== Public Events ==== | ||
| ** {{wiki:PublicEvent.gif|}} GottenCacheImage ** | ** {{wiki:PublicEvent.gif|}} GottenCacheImage ** | ||