Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.core.tilecache [2015/09/17 10:40]
admin
+++ thinkgeo.mapsuite.core.tilecache [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.TileCache ======
+{{section>upgrade_map_suite_to_10.0}}
 This is the base class for TileCache system.
 ===== Inheritance Hierarchy =====
@@ Line 7: / Line 10: @@
       *[[ThinkGeo.MapSuite.Core.NativeImageTileCache]]
 ===== Members Summary =====
-=== Public Constructors ===
+==== Public Constructors ====
-=== Protected Constructors ===
+==== Protected Constructors ====
-<div class_table>
+** {{wiki:ProtectedMethod.gif|}} TileCache(String,TileImageFormat,TileMatrix) **
-**{{wiki:ProtectedMethod.gif|}}[[#TileCache(String,TileImageFormat,TileMatrix)|TileCache]]**
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]],[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]
-  * **DeclaringType**:N/A
-  * **Summary**:This is the constructor of the class.
-</div>
-=== Public Methods ===
+  * //This is the constructor of the class.//
-<div class_table>
+== Remarks ==
-**{{wiki:PublicMethod.gif|}}[[#ClearCache()|ClearCache]]**
+  * //N/A//
-  * **Parameters**:N/A
+== Parameters ==
-  * **DeclaringType**:N/A
+  * //cacheId//
-  * **Summary**:This method will clear all the tiles in the tileCache.
+    * Type:String
-</div>
+    * Description:This is the cache identifier which marks its difference with other TileCache.
-<div class_table>
+  * //imageFormat//
-**{{wiki:PublicMethod.gif|}}[[#DeleteTile(Tile)|DeleteTile]]**
+    * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
+    * Description:This is the imageFormate showing what kind of image we are trying to save.
-  * **DeclaringType**:N/A
-  * **Summary**:This method will delete the target tile passed in.
-</div>
-<div class_table>
+  * //tileMatrix//
-**{{wiki:PublicMethod.gif|}}[[#DeleteTiles(RectangleShape)|DeleteTiles]]**
+    * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+    * Description:This is the tile matrix system which is used for caculating tiles.
-  * **DeclaringType**:N/A
-  * **Summary**:This method will delete the tiles within the passed in worldExtent.
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]**
+==== Public Methods ====
-  * **Parameters**:Object
+** {{wiki:PublicMethod.gif|}} SaveTile(Tile) **
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //This method will save the target tile passed in.//
-**{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]**
+== Remarks ==
-  * **Parameters**:N/A
+  * //This method will not take effect when the ReadOnly is set to true.//
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+== Return Value ==
-**{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]**
+  * Type:Void
-  * **Parameters**:N/A
+  * Description:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+== Parameters ==
-**{{wiki:PublicMethod.gif|}}[[#SaveTile(Tile)|SaveTile]]**
+  * //tile//
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
+    * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
-  * **DeclaringType**:N/A
+    * Description:The target tile to be saved.
-  * **Summary**:This method will save the target tile passed in.
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#SaveTiles(Bitmap,RectangleShape,Boolean)|SaveTiles]]**
+** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape,Boolean) **
-  * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Boolean
-  * **DeclaringType**:N/A
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //N/A//
-**{{wiki:PublicMethod.gif|}}[[#SaveTiles(Bitmap,RectangleShape)|SaveTiles]]**
+== Remarks ==
-  * **Parameters**:Bitmap,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+  * //N/A//
-  * **DeclaringType**:N/A
-  * **Summary**:This method will save the bitmap with its extent attached into tiles.
-</div>
-<div class_table>
+== Return Value ==
-**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]**
+  * Type:Void
-  * **Parameters**:N/A
+  * Description:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-=== Protected Methods ===
+== Parameters ==
-<div class_table>
+  * //bitmap//
-**{{wiki:ProtectedMethod.gif|}}[[#ClearCacheCore()|ClearCacheCore]]**
+    * Type:Bitmap
-  * **Parameters**:N/A
+    * Description:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method.
-</div>
-<div class_table>
+  * //bitmapExtent//
-**{{wiki:ProtectedMethod.gif|}}[[#DeleteTileCore(Tile)|DeleteTileCore]]**
+    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
+    * Description:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method.
-</div>
-<div class_table>
+  * //saveContainedCellsOnly//
-**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]**
+    * Type:Boolean
-  * **Parameters**:N/A
+    * Description:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]**
+** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape) **
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //This method will save the bitmap with its extent attached into tiles.//
-**{{wiki:ProtectedMethod.gif|}}[[#SaveTileCore(Tile)|SaveTileCore]]**
+== Remarks ==
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
+  * //N/A//
-  * **DeclaringType**:N/A
-  * **Summary**:This abstract method will save the target tile passed in, for each sub TileCache class must implement this method.
-</div>
-=== Public Properties ===
+== Return Value ==
-**{{wiki:PublicProperty.gif|}}[[#CacheId|CacheId]]**
+  * Type:Void
-  * **Return**:String
+  * Description:N/A
-  * **Summary**:Gets or sets the id of the TileCache.
-**{{wiki:PublicProperty.gif|}}[[#ImageFormat|ImageFormat]]**
+== Parameters ==
-  * **Return**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]
+  * //bitmap//
-  * **Summary**:Gets or sets the tile image format.
+    * Type:Bitmap
+    * Description:The target bitmap to be saved into tiles.
-**{{wiki:PublicProperty.gif|}}[[#JpegQuality|JpegQuality]]**
+  * //bitmapExtent//
-  * **Return**:Int16
+    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
-  * **Summary**:Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.
+    * Description:The target extent for the bitmap.
-**{{wiki:PublicProperty.gif|}}[[#LoadingTileImage|LoadingTileImage]]**
+<div newline></div>
-  * **Return**:Bitmap
+** {{wiki:PublicMethod.gif|}} DeleteTiles(RectangleShape) **
-  * **Summary**:This property returns back a preset image showing the Tile is loading.
-**{{wiki:PublicProperty.gif|}}[[#NoDataTileImage|NoDataTileImage]]**
+  * //This method will delete the tiles within the passed in worldExtent.//
-  * **Return**:Bitmap
+== Remarks ==
-  * **Summary**:This property returns back a preset image showing the tile data is missing.
+  * //N/A//
-**{{wiki:PublicProperty.gif|}}[[#TileAccessMode|TileAccessMode]]**
+== Return Value ==
-  * **Return**:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]]
+  * Type:Void
-  * **Summary**:Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete
+  * Description:N/A
-**{{wiki:PublicProperty.gif|}}[[#TileMatrix|TileMatrix]]**
+== Parameters ==
-  * **Return**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]
+  * //worldExtent//
-  * **Summary**:Gets or sets the TileMatrix which is used in caculation for tiles.
+    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+    * Description:The target extent to delete all tiles within it.
-=== Protected Properties ===
+<div newline></div>
-=== Public Events ===
+** {{wiki:PublicMethod.gif|}} DeleteTile(Tile) **
-===== Public Constructors =====
-===== Protected Constructors =====
-=== TileCache(String,TileImageFormat,TileMatrix) ===
-This is the constructor of the class.
-==== Remarks ====
-N/A
-==== Parameters ====
-**cacheId**
-  * **Type**:String
-  * **Description:This is the cache identifier which marks its difference with other TileCache.
-**imageFormat**
+  * //This method will delete the target tile passed in.//
-  * **Type**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]
+== Remarks ==
-  * **Description:This is the imageFormate showing what kind of image we are trying to save.
+  * //This method will not take effect when the ReadOnly is set to true.//
-**tileMatrix**
+== Return Value ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]
+  * Type:Void
-  * **Description:This is the tile matrix system which is used for caculating tiles.
+  * Description:N/A
-[[#Protected Constructors|Go Back]]
+== Parameters ==
-===== Public Methods =====
+  * //tile//
-=== ClearCache() ===
+    * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
-This method will clear all the tiles in the tileCache.
+    * Description:The target tile to be deleted.
-==== Remarks ====
-This method will not take effect when the ReadOnly is set to true.
-**Return Value**
+<div newline></div>
-  * **Return Type**:Void
+** {{wiki:PublicMethod.gif|}} ClearCache() **
-  * **Description**:N/A
-==== Parameters ====
+  * //This method will clear all the tiles in the tileCache.//
-[[#Public Methods|Go Back]]
+== Remarks ==
-=== DeleteTile(Tile) ===
+  * //This method will not take effect when the ReadOnly is set to true.//
-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 Value ==
-  * **Return Type**:Void
+  * Type:Void
-  * **Description**:N/A
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-**tile**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
+** {{wiki:PublicMethod.gif|}} ToString() **
-  * **Description**:The target tile to be deleted.
-[[#Public Methods|Go Back]]
+  * //N/A//
-=== DeleteTiles(RectangleShape) ===
+== Remarks ==
-This method will delete the tiles within the passed in worldExtent.
+  * //N/A//
-==== Remarks ====
-N/A
-**Return Value**
+== Return Value ==
-  * **Return Type**:Void
+  * Type:String
-  * **Description**:N/A
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-**worldExtent**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-  * **Description**:The target extent to delete all tiles within it.
-[[#Public Methods|Go Back]]
+  * //N/A//
-=== Equals(Object) ===
+== Remarks ==
-N/A
+  * //N/A//
-==== Remarks ====
-N/A
-**Return Value**
+== Return Value ==
-  * **Return Type**:Boolean
+  * Type:Boolean
-  * **Description**:N/A
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-**obj**
+  * //obj//
-  * **Type**:Object
+    * Type:Object
-  * **Description**:N/A
+    * Description:N/A
-[[#Public Methods|Go Back]]
+<div newline></div>
-=== GetHashCode() ===
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+  * //N/A//
-  * **Return Type**:Int32
+== Remarks ==
-  * **Description**:N/A
+  * //N/A//
-==== Parameters ====
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Int32
-=== GetType() ===
+  * Description:N/A
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:Type
+<div newline></div>
-  * **Description**:N/A
+** {{wiki:PublicMethod.gif|}} GetType() **
-==== Parameters ====
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-=== SaveTile(Tile) ===
+  * //N/A//
-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 Value ==
-  * **Return Type**:Void
+  * Type:Type
-  * **Description**:N/A
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-**tile**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
+==== Protected Methods ====
-  * **Description**:The target tile to be saved.
+** {{wiki:ProtectedMethod.gif|}} ClearCacheCore() **
-[[#Public Methods|Go Back]]
+  * //This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method.//
-=== SaveTiles(Bitmap,RectangleShape,Boolean) ===
+== Remarks ==
-N/A
+  * //This method will not take effect when the ReadOnly is set to true.//
-==== Remarks ====
-N/A
-**Return Value**
+== Return Value ==
-  * **Return Type**:Void
+  * Type:Void
-  * **Description**:N/A
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-**bitmap**
+<div newline></div>
-  * **Type**:Bitmap
+** {{wiki:ProtectedMethod.gif|}} SaveTileCore(Tile) **
-  * **Description**:N/A
-**bitmapExtent**
+  * //This abstract method will save the target tile passed in, for each sub TileCache class must implement this method.//
-  * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+== Remarks ==
-  * **Description**:N/A
+  * //This method will not take effect when the ReadOnly is set to true.//
-**saveContainedCellsOnly**
+== Return Value ==
-  * **Type**:Boolean
+  * Type:Void
-  * **Description**:N/A
+  * Description:N/A
-[[#Public Methods|Go Back]]
+== Parameters ==
-=== SaveTiles(Bitmap,RectangleShape) ===
+  * //tile//
-This method will save the bitmap with its extent attached into tiles.
+    * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
-==== Remarks ====
+    * Description:The target tile to be saved.
-N/A
-**Return Value**
+<div newline></div>
-  * **Return Type**:Void
+** {{wiki:ProtectedMethod.gif|}} DeleteTileCore(Tile) **
-  * **Description**:N/A
-==== Parameters ====
+  * //This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method.//
-**bitmap**
+== Remarks ==
-  * **Type**:Bitmap
+  * //This method will not take effect when the ReadOnly is set to true.//
-  * **Description**:The target bitmap to be saved into tiles.
-**bitmapExtent**
+== Return Value ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+  * Type:Void
-  * **Description**:The target extent for the bitmap.
+  * Description:N/A
-[[#Public Methods|Go Back]]
+== Parameters ==
-=== ToString() ===
+  * //tile//
-N/A
+    * Type:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
-==== Remarks ====
+    * Description:The target tile to be deleted.
-N/A
-**Return Value**
+<div newline></div>
-  * **Return Type**:String
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-  * **Description**:N/A
-==== Parameters ====
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-===== Protected Methods =====
+  * //N/A//
-=== 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 Value ==
-  * **Return Type**:Void
+  * Type:Void
-  * **Description**:N/A
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-[[#Protected Methods|Go Back]]
+<div newline></div>
-=== DeleteTileCore(Tile) ===
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-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**
+  * //N/A//
-  * **Return Type**:Void
+== Remarks ==
-  * **Description**:N/A
+  * //N/A//
-==== Parameters ====
+== Return Value ==
-**tile**
+  * Type:Object
-  * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
+  * Description:N/A
-  * **Description**:The target tile to be deleted.
-[[#Protected Methods|Go Back]]
+== Parameters ==
-=== Finalize() ===
+<div newline></div>
-N/A
+==== Public Properties ====
-==== Remarks ====
+** {{wiki:PublicProperty.gif|}} TileMatrix **
+Gets or sets the TileMatrix which is used in caculation for tiles.
+== Remarks ==
 N/A
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]
-**Return Value**
+** {{wiki:PublicProperty.gif|}} TileAccessMode **
-  * **Return Type**:Void
-  * **Description**:N/A
-==== Parameters ====
+Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete
-[[#Protected Methods|Go Back]]
+== Remarks ==
-=== MemberwiseClone() ===
+If you want it to take effect, you need set the ReadOnly property false.
-N/A
+== Return Value ==
-==== Remarks ====
+  * Type:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]]
-N/A
-**Return Value**
+** {{wiki:PublicProperty.gif|}} NoDataTileImage **
-  * **Return Type**:Object
-  * **Description**:N/A
-==== Parameters ====
+This property returns back a preset image showing the tile data is missing.
-[[#Protected Methods|Go Back]]
+== Remarks ==
-=== SaveTileCore(Tile) ===
+N/A
-This abstract method will save the target tile passed in, for each sub TileCache class must implement this method.
+== Return Value ==
-==== Remarks ====
+  * Type:Bitmap
-This method will not take effect when the ReadOnly is set to true.
-**Return Value**
+** {{wiki:PublicProperty.gif|}} LoadingTileImage **
-  * **Return Type**:Void
-  * **Description**:N/A
-==== Parameters ====
+This property returns back a preset image showing the Tile is loading.
-**tile**
+== Remarks ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.Tile|Tile]]
-  * **Description**:The target tile to be saved.
-[[#Protected Methods|Go Back]]
-===== Public Properties =====
-=== CacheId ===
-Gets or sets the id of the TileCache.
-==== Remarks ====
 N/A
-==== Return Value ====
+== Return Value ==
-**Return Type**:String
+  * Type:Bitmap
+** {{wiki:PublicProperty.gif|}} ImageFormat **
-[[#Public Properties|Go Back]]
-=== ImageFormat ===
 Gets or sets the tile image format.
-==== Remarks ====
+== Remarks ==
 N/A
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]
+  * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]
+** {{wiki:PublicProperty.gif|}} JpegQuality **
-[[#Public Properties|Go Back]]
-=== JpegQuality ===
 Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.
-==== Remarks ====
+== Remarks ==
 N/A
-==== Return Value ====
+== Return Value ==
-**Return Type**:Int16
+  * Type:Int16
-[[#Public Properties|Go Back]]
+** {{wiki:PublicProperty.gif|}} CacheId **
-=== LoadingTileImage ===
-This property returns back a preset image showing the Tile is loading.
-==== Remarks ====
-N/A
-==== Return Value ====
-**Return Type**:Bitmap
-[[#Public Properties|Go Back]]
+Gets or sets the id of the TileCache.
-=== NoDataTileImage ===
+== Remarks ==
-This property returns back a preset image showing the tile data is missing.
-==== Remarks ====
-N/A
-==== Return Value ====
-**Return Type**:Bitmap
-[[#Public Properties|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**:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]]
-[[#Public Properties|Go Back]]
-=== TileMatrix ===
-Gets or sets the TileMatrix which is used in caculation for tiles.
-==== Remarks ====
 N/A
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]
+  * Type:String
-[[#Public Properties|Go Back]]
+==== Protected Properties ====
-===== Protected Properties =====
+==== Public Events ====
-===== Public Events =====

User Tools

Site Tools

Differences

Page Tools