thinkgeo.mapsuite.mvcedition.layeroverlay
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mvcedition.layeroverlay [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.MvcEdition.LayerOverlay ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | Represents an Overlay that contains layers. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.MvcEdition.Overlay]] | ||
| - | ***[[ThinkGeo.MapSuite.MvcEdition.LayerOverlay]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LayerOverlay()|LayerOverlay]] | | | Initialize an instance of the LayerOverlay class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LayerOverlay(String)|LayerOverlay]] | String | | Initialize an instance of the LayerOverlay class with the overlay identifier specified. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LayerOverlay(String, Boolean, TileType)|LayerOverlay]] | String, Boolean, [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]] | | Initialize an instance of the LayerOverlay class with the overlay identifier, IsBaseOverlay boolean value and the value indicating whether to use tiling. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DataBindTo(String, String)|DataBindTo]] | String, String | | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas, Object, RectangleShape, GeographyUnit)|Draw]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Object, [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | Draw all of the layers to the image object using the parameters specified. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#FromJson(String)|FromJson]] | String | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Load this object from a json string. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateCacheImages(Double, RectangleShape, GeographyUnit)|GenerateCacheImages]] | Double, [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | Generates the images to the server cache by scale. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateCacheImages(ZoomLevel, RectangleShape, GeographyUnit)|GenerateCacheImages]] | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]], [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | Generates images to the server cache by zoomLevel. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBaseEpsgProjection()|GetBaseEpsgProjection]] | | | Returns an EPSG string that indicates the projection of the LayerOverlay. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]] | | | Gets the smallest extent that includes all of the features of all layers in the LayerOverlay. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Redraw()|Redraw]] | | | Redraw this overlay. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SetBaseEpsgProjection(String)|SetBaseEpsgProjection]] | String | | Sets the EPSG projection of the LayerOverlay when it is a base overlay. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToJson()|ToJson]] | | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Returns a JSON string which contains the information for creating an overlay at the client side. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(GeoCanvas, Object, RectangleShape, GeographyUnit)|DrawCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Object, [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | | Draw all of the layers to the image object using the parameters specified. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]] | Page | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Registers a Javascript library URL string to the client HTML page. | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ActionTriggers|ActionTriggers]] | Collection<[[ThinkGeo.MapSuite.MvcEdition.ActionTrigger|ActionTrigger]]> | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AutoRefreshInterval|AutoRefreshInterval]] | TimeSpan | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Gets or sets the time interval in which the MarkerOverlay refreshes itself. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ClientCache|ClientCache]] | [[ThinkGeo.MapSuite.MvcEdition.ClientCache|ClientCache]] | | Gets or sets the ClientCache object that contains the configuration for the browser cache of this overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]] | String | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Gets the identifier for the overlay to be found. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsBaseOverlay|IsBaseOverlay]] | Boolean | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Gets or sets a value that indicates whether the overlay is a base overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsMultiThreadDisabled|IsMultiThreadDisabled]] | Boolean | | Gets or sets whether the multi-thread is disabled or not. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]] | Boolean | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden) | Gets or sets a value that indicates whether the overlay is visible on the map. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsVisibleInOverlaySwitcher|IsVisibleInOverlaySwitcher]] | Boolean | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#JpegQuality|JpegQuality]] | Int32 | | Gets or sets the quality of the JPEG image that is sent to the web browser. Valid values are between 1 - 100, inclusive. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Layers|Layers]] | [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | | Gets a GeoCollection that contains the layers that will draw on the image that is sent to the browser. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#OnClientAutoRefreshTick|OnClientAutoRefreshTick]] | String | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Opacity|Opacity]] | Single | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | Gets or sets the opacity level of the overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ServerCache|ServerCache]] | [[ThinkGeo.MapSuite.MvcEdition.ServerCache|ServerCache]] | | Gets or sets the server cache in the overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileHeight|TileHeight]] | Int32 | | Gets or sets the height of each tile if the layer is in MultipleTile mode. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileMargin|TileMargin]] | Int32 | | Gets or sets the number of extra rows and colums of tiles on each side that will surround the minimum grid tiles to cover the map. Used only when in MultipleTile mode. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileType|TileType]] | [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]] | | Gets or sets whether or not the LayerOverlay uses tiling. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileWidth|TileWidth]] | Int32 | | Gets or sets the width of each tile if the layer is in MultipleTile mode. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TransitionEffect|TransitionEffect]] | [[ThinkGeo.MapSuite.MvcEdition.TransitionEffect|TransitionEffect]] | | Gets or sets the transition effect to use when the map is zoomed. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TransitionEffectDelayInMilliseconds|TransitionEffectDelayInMilliseconds]] | Int32 | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#WebImageFormat|WebImageFormat]] | [[ThinkGeo.MapSuite.MvcEdition.WebImageFormat|WebImageFormat]] | | Gets or sets the format of the image that is sent to the web browser. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#WrapDateline|WrapDateline]] | [[ThinkGeo.MapSuite.MvcEdition.WrapDatelineMode|WrapDatelineMode]] | | Gets or sets a value that indicates whether the overlay wraps at the date line. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#ExtraParameter|ExtraParameter]] | String | | Gets or sets extra parameters for current overlay. | | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#OverlayType|OverlayType]] | String | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden) | Gets a string that indicates the overlay type. | | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#Projection|Projection]] | String | | Gets or sets projection of current overlay for requesting images. | | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== LayerOverlay() ==== | ||
| - | Initialize an instance of the LayerOverlay class. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the LayerOverlay class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== LayerOverlay(String) ==== | ||
| - | Initialize an instance of the LayerOverlay class with the overlay identifier specified. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the LayerOverlay class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | id | String<!-- System.String --> | The identifier string used to retrieve the overlay for collection. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== LayerOverlay(String, Boolean, TileType) ==== | ||
| - | Initialize an instance of the LayerOverlay class with the overlay identifier, IsBaseOverlay boolean value and the value indicating whether to use tiling. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the LayerOverlay class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | id | String<!-- System.String --> | The identifier string used to retrieve the overlay for collection. | | ||
| - | | isBaseOverlay | Boolean<!-- System.Boolean --> | A boolean value that indicates whether this overlay is a base overlay. | | ||
| - | | tileType | [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]]<!-- ThinkGeo.MapSuite.MvcEdition.TileType --> | The TileType that indicates whether this overlay uses tiling. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== DataBindTo(String, String) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | controllerName | String<!-- System.String --> | | | ||
| - | | actionName | String<!-- System.String --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Draw(GeoCanvas, Object, RectangleShape, GeographyUnit) ==== | ||
| - | Draw all of the layers to the image object using the parameters specified. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | The GeoCanvas object that the layers will draw on. | | ||
| - | | nativeImage | Object<!-- System.Object --> | The image object to which all of the layers will be drawn. Usually it is a bitmap. | | ||
| - | | canvasExtent | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | The extent in which the features of the layers will be drawn. | | ||
| - | | mapUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | The geographic unit that the map will use to draw. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== FromJson(String) ==== | ||
| - | Load this object from a json string. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | jsonString | String<!-- System.String --> | a json string | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GenerateCacheImages(Double, RectangleShape, GeographyUnit) ==== | ||
| - | Generates the images to the server cache by scale. | ||
| - | === Overloads === | ||
| - | Generates the images to the server cache. | ||
| - | === Remarks === | ||
| - | This method will generate images to the server cache if you enable the ServerCache on this LayerOverlay. You can use this method to fill your server cache to enhance the performance of your web site. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | scale | Double<!-- System.Double --> | The scale that is used to calculate the coordinates of the images. | | ||
| - | | cacheExtent | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | The extent of the region for which the cache images will be generated. | | ||
| - | | mapUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | The unit of map. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GenerateCacheImages(ZoomLevel, RectangleShape, GeographyUnit) ==== | ||
| - | Generates images to the server cache by zoomLevel. | ||
| - | === Overloads === | ||
| - | Generates the images to the server cache. | ||
| - | === Remarks === | ||
| - | This method will generate images to the server cache if you enable the ServerCache on this LayerOverlay. You can use this method to fill your server cache to enhance the performance of your web site. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | zoomLevel | [[ThinkGeo.MapSuite.Core.ZoomLevel|ZoomLevel]]<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> | The zoomlevel at which the images will be generated. | | ||
| - | | cacheExtent | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | The extent of the region for which the cached images will be generated. | | ||
| - | | mapUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | The unit of map. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetBaseEpsgProjection() ==== | ||
| - | Returns an EPSG string that indicates the projection of the LayerOverlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | An EPSG string that indicates the projection of the LayerOverlay. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetBoundingBox() ==== | ||
| - | Gets the smallest extent that includes all of the features of all layers in the LayerOverlay. | ||
| - | === Remarks === | ||
| - | If you have several layers, with one justified up and to the right and another justified down and to the left, this method will combine all of the current extents to make one composite extent. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | The smallest extent that includes all of the features of all layers in the LayerOverlay. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Redraw() ==== | ||
| - | Redraw this overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== SetBaseEpsgProjection(String) ==== | ||
| - | Sets the EPSG projection of the LayerOverlay when it is a base overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | epsgProjection | String<!-- System.String --> | A string that represents the projection of the LayerOverlay. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToJson() ==== | ||
| - | Returns a JSON string which contains the information for creating an overlay at the client side. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | A JSON string which is used to create an overlay at the client side. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== DrawCore(GeoCanvas, Object, RectangleShape, GeographyUnit) ==== | ||
| - | Draw all of the layers to the image object using the parameters specified. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | The GeoCanvas object that the layers will draw on. | | ||
| - | | nativeImage | Object<!-- System.Object --> | The image object to which all of the layers will be drawn. Usually it is a bitmap. | | ||
| - | | canvasExtent | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | The extent in which the features of the layers will be drawn. | | ||
| - | | mapUnit | [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit --> | The geographic unit that the map will use to draw. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== RegisterJavaScriptLibraryCore(Page) ==== | ||
| - | Registers a Javascript library URL string to the client HTML page. | ||
| - | === Remarks === | ||
| - | The <strong>RegisterJavaScriptLibraryCore</strong> method allows derived classes to override and register their own Javascript library URL to the HTML page. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | page | Page<!-- System.Web.UI.Page --> | The page object that is used for registering the javascript library. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== ActionTriggers ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.MvcEdition.ActionTrigger|ActionTrigger]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.ActionTrigger} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Attribution ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== AutoRefreshInterval ==== | ||
| - | Gets or sets the time interval in which the MarkerOverlay refreshes itself. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | TimeSpan<!-- System.TimeSpan --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ClientCache ==== | ||
| - | Gets or sets the ClientCache object that contains the configuration for the browser cache of this overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.ClientCache|ClientCache]]<!-- ThinkGeo.MapSuite.MvcEdition.ClientCache --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Id ==== | ||
| - | Gets the identifier for the overlay to be found. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsBaseOverlay ==== | ||
| - | Gets or sets a value that indicates whether the overlay is a base overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsMultiThreadDisabled ==== | ||
| - | Gets or sets whether the multi-thread is disabled or not. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsVisible ==== | ||
| - | Gets or sets a value that indicates whether the overlay is visible on the map. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsVisibleInOverlaySwitcher ==== | ||
| - | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== JpegQuality ==== | ||
| - | Gets or sets the quality of the JPEG image that is sent to the web browser. Valid values are between 1 - 100, inclusive. | ||
| - | === Remarks === | ||
| - | The <strong>JpegQuality</strong> property determines the quality of the JPEG image that is sent to the browser if the WebImageFormat is Jpeg. Setting this property to a lower value will reduce the image filesize. The value must be between 1 - 100. The default is 100. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Layers ==== | ||
| - | Gets a GeoCollection that contains the layers that will draw on the image that is sent to the browser. | ||
| - | === Remarks === | ||
| - | The <strong>Layers</strong> property holds all of the layers that are used by the <strong>Draw</strong> method. The Draw method loops through all layers to filter out features and draw with specified styles to the image that will be sent to the browser. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.Core.Layer|Layer]]><!-- ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.Layer} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Name ==== | ||
| - | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== OnClientAutoRefreshTick ==== | ||
| - | Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Opacity ==== | ||
| - | Gets or sets the opacity level of the overlay. | ||
| - | === Remarks === | ||
| - | The <strong>Opacity</strong> property enables you to specify a level of transparency for the overlay. When this property is set to a value less than 100 percent (1.00), the entire overlay is made more transparent. The lower the value, the more transparent it is. Setting this property to a value of 0 percent (0.00) makes the overlay completely invisible. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ServerCache ==== | ||
| - | Gets or sets the server cache in the overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.ServerCache|ServerCache]]<!-- ThinkGeo.MapSuite.MvcEdition.ServerCache --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TileHeight ==== | ||
| - | Gets or sets the height of each tile if the layer is in MultipleTile mode. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TileMargin ==== | ||
| - | Gets or sets the number of extra rows and colums of tiles on each side that will surround the minimum grid tiles to cover the map. Used only when in MultipleTile mode. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TileType ==== | ||
| - | Gets or sets whether or not the LayerOverlay uses tiling. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]]<!-- ThinkGeo.MapSuite.MvcEdition.TileType --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TileWidth ==== | ||
| - | Gets or sets the width of each tile if the layer is in MultipleTile mode. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TransitionEffect ==== | ||
| - | Gets or sets the transition effect to use when the map is zoomed. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.TransitionEffect|TransitionEffect]]<!-- ThinkGeo.MapSuite.MvcEdition.TransitionEffect --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TransitionEffectDelayInMilliseconds ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== WebImageFormat ==== | ||
| - | Gets or sets the format of the image that is sent to the web browser. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.WebImageFormat|WebImageFormat]]<!-- ThinkGeo.MapSuite.MvcEdition.WebImageFormat --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== WrapDateline ==== | ||
| - | Gets or sets a value that indicates whether the overlay wraps at the date line. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.WrapDatelineMode|WrapDatelineMode]]<!-- ThinkGeo.MapSuite.MvcEdition.WrapDatelineMode --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ==== ExtraParameter ==== | ||
| - | Gets or sets extra parameters for current overlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ==== OverlayType ==== | ||
| - | Gets a string that indicates the overlay type. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ==== Projection ==== | ||
| - | Gets or sets projection of current overlay for requesting images. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.LayerOverlay --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MvcEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.MvcEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.mvcedition.layeroverlay.1440040131.txt.gz ยท Last modified: 2015/09/21 03:33 (external edit)
