User Tools

Site Tools

Trace:
thinkgeo.mapsuite.mvcedition.arcgisserverrestoverlay

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.mvcedition.arcgisserverrestoverlay [2015/08/20 03:08]
127.0.0.1 external edit 		— (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay ====== 
- 
- 
- 
-<!-- Class --> 
-This class is used to display data from ArcGIS Server 9.3 (and up) Mapping Services using the REST API. More detail on the REST API is available at http://​sampleserver1.arcgisonline.com/​ArcGIS/​SDK/​REST/​index.html ;​specifically,​ the URL provided to this layer should be an export service URL: http://​sampleserver1.arcgisonline.com/​ArcGIS/​SDK/​REST/​export.html 
-===== Inheritance Hierarchy ===== 
-*System.Object 
-**[[ThinkGeo.MapSuite.MvcEdition.Overlay]] 
-***[[ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay]] 
-===== Members Summary ===== 
-==== Public Constructors ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ArcGISServerRestOverlay()|ArcGISServerRestOverlay]] ​  ​| ​   |    | Initialize an instance of the ArcGISServerRestOverlay class with none parameter. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ArcGISServerRestOverlay(String)|ArcGISServerRestOverlay]] ​  | String ​  ​| ​   | Initialize an instance of the ArcGISServerRestOverlay class. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ArcGISServerRestOverlay(String,​ Uri)|ArcGISServerRestOverlay]] ​  | String, Uri   ​| ​   | Initialize an instance of the ArcGISServerRestOverlay class. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ArcGISServerRestOverlay(Uri)|ArcGISServerRestOverlay]] ​  | Uri   ​| ​   | Initialize an instance of the ArcGISServerRestOverlay class. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ArcGISServerRestOverlay(String,​ Uri, TileType)|ArcGISServerRestOverlay]] ​  | String, Uri, [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]] ​  ​| ​   | Initialize an instance of the ArcGISServerRestOverlay class. ​  | 
- 
-==== Protected Constructors ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
-==== Public Methods ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​FromJson(String)|FromJson]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden) ​  | Load this object from a json string. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{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}}[[#​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}}[[#​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}}[[#​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}}[[#​IsVisible|IsVisible]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] ​  | 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}}[[#​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]](overriden) ​  | Don't support auto tick event by default. ​  | 
-| {{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}}[[#​Parameters|Parameters]] ​  | Dictionary<​String,​String> ​  ​| ​   | Gets a dictionary whose items will be passed to the ArcGIS REST Server server as parameters. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Projection|Projection]] ​  | String ​  ​| ​   | Gets or sets a string that will be sent to the ArcGIS REST server to get the images in the specific projection. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​ServerUri|ServerUri]] ​  | Uri   ​| ​   | Gets or sets the URI that specifies the locations of the ArcGIS Rest servers. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TileHeight|TileHeight]] ​  | Int32   ​| ​   | Gets or sets the height of each tile, if the WmsOverlay uses tiling. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TileType|TileType]] ​  | [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]] ​  ​| ​   | Gets or sets whether or not the ArcGISServerRestOverlay uses tiling. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TileWidth|TileWidth]] ​  | Int32   ​| ​   | Gets or sets the width of each tile, if the WmsOverlay uses tiling. ​  | 
-| {{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   ​| ​   |    | 
- 
-==== Protected Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
-| {{wiki:​ProtectedProperty.gif|Protected Property}}[[#​OverlayType|OverlayType]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]](overriden) ​  | Gets a string that indicates the overlay type.   | 
- 
-==== Public Events ==== 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ 
- 
-===== Public Constructors ===== 
-==== ArcGISServerRestOverlay() ==== 
-Initialize an instance of the ArcGISServerRestOverlay class with none parameter. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-[[#Public Constructors|Go Back]] 
-==== ArcGISServerRestOverlay(String) ==== 
-Initialize an instance of the ArcGISServerRestOverlay class. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| id   | String<​!-- System.String --> ​  | The identifier string of the ArcGISServerRestOverlay. ​  | 
- 
-[[#Public Constructors|Go Back]] 
-==== ArcGISServerRestOverlay(String,​ Uri) ==== 
-Initialize an instance of the ArcGISServerRestOverlay class. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| id   | String<​!-- System.String --> ​  | The identifier string of the ArcGISServerRestOverlay. ​  | 
-| serverUri ​  | Uri<!-- System.Uri --> ​  | The uri of the ArcGIS REST SERVER ​  | 
- 
-[[#Public Constructors|Go Back]] 
-==== ArcGISServerRestOverlay(Uri) ==== 
-Initialize an instance of the ArcGISServerRestOverlay class. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| serverUri ​  | Uri<!-- System.Uri --> ​  | The uri of the ArcGIS REST SERVER ​  | 
- 
-[[#Public Constructors|Go Back]] 
-==== ArcGISServerRestOverlay(String,​ Uri, TileType) ==== 
-Initialize an instance of the ArcGISServerRestOverlay class. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| id   | String<​!-- System.String --> ​  | The identifier string of the ArcGISServerRestOverlay. ​  | 
-| serverUri ​  | Uri<!-- System.Uri --> ​  | The uri of the ArcGIS REST SERVER ​  | 
-| tileType ​  | [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]]<​!-- ThinkGeo.MapSuite.MvcEdition.TileType --> ​  | The Tile Type of the layer   | 
- 
-[[#Public Constructors|Go Back]] 
-===== Protected Constructors ===== 
-===== Public Methods ===== 
-==== 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(overriden) --> 
-[[#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]] 
-==== 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 ===== 
-==== 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 ===== 
-==== 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]] 
-==== 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]] 
-==== 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 --> 
-[[#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]] 
-==== 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 ==== 
-Don't support auto tick event by default. 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.Overlay(overriden) --> 
-[[#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]] 
-==== Parameters ==== 
-Gets a dictionary whose items will be passed to the ArcGIS REST Server server as parameters. 
-=== Return Value === 
-^ Return Type ^ 
-| Dictionary<​String,​String><​!-- System.Collections.Generic.Dictionary{System.String,​System.String} --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay --> 
-[[#Public Properties|Go Back]] 
-==== Projection ==== 
-Gets or sets a string that will be sent to the ArcGIS REST server to get the images in the specific projection. 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay --> 
-[[#Public Properties|Go Back]] 
-==== ServerUri ==== 
-Gets or sets the URI that specifies the locations of the ArcGIS Rest servers. 
-=== Return Value === 
-^ Return Type ^ 
-| Uri<!-- System.Uri --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay --> 
-[[#Public Properties|Go Back]] 
-==== TileHeight ==== 
-Gets or sets the height of each tile, if the WmsOverlay uses tiling. 
-=== Return Value === 
-^ Return Type ^ 
-| Int32<​!-- System.Int32 --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay --> 
-[[#Public Properties|Go Back]] 
-==== TileType ==== 
-Gets or sets whether or not the ArcGISServerRestOverlay uses tiling. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.MvcEdition.TileType|TileType]]<​!-- ThinkGeo.MapSuite.MvcEdition.TileType --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay --> 
-[[#Public Properties|Go Back]] 
-==== TileWidth ==== 
-Gets or sets the width of each tile, if the WmsOverlay uses tiling. 
-=== Return Value === 
-^ Return Type ^ 
-| Int32<​!-- System.Int32 --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay --> 
-[[#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.ArcGISServerRestOverlay --> 
-[[#Public Properties|Go Back]] 
-==== TransitionEffectDelayInMilliseconds ==== 
-=== Return Value === 
-^ Return Type ^ 
-| Int32<​!-- System.Int32 --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay --> 
-[[#Public Properties|Go Back]] 
-===== Protected Properties ===== 
-==== 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]] 
-===== Public Events ===== 
-__NOTOC__ 
-[[Category:​MvcEdition]] 
-[[Category:​ThinkGeo.MapSuite.MvcEdition]] 
-[[Category:​UpdateDocumentation]] 
  
thinkgeo.mapsuite.mvcedition.arcgisserverrestoverlay.1440040131.txt.gz ยท Last modified: 2015/09/21 03:32 (external edit)

Page Tools