This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
thinkgeo.mapsuite.webedition.arcgisserverrestoverlay [2015/09/22 08:48] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay ====== | ||
| - | 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.WebEdition.Overlay | ||
| - | ***ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay** | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay() ** | ||
| - | |||
| - | * //Initialize an instance of the ArcGISServerRestOverlay class with none parameter.// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#ArcGISServerRestOverlay.28.29// | ||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay(String) ** | ||
| - | |||
| - | * //Initialize an instance of the ArcGISServerRestOverlay class.// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#ArcGISServerRestOverlay.28String.29// | ||
| - | == Parameters == | ||
| - | * //id// | ||
| - | * Type:String | ||
| - | * Description:The identifier string of the ArcGISServerRestOverlay. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay(String,Uri) ** | ||
| - | |||
| - | * //Initialize an instance of the ArcGISServerRestOverlay class.// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#ArcGISServerRestOverlay.28String.2C_Uri.29// | ||
| - | == Parameters == | ||
| - | * //id// | ||
| - | * Type:String | ||
| - | * Description:The identifier string of the ArcGISServerRestOverlay. | ||
| - | |||
| - | * //serverUri// | ||
| - | * Type:Uri | ||
| - | * Description:The uri of the ArcGIS REST SERVER | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay(String,Uri,TileType) ** | ||
| - | |||
| - | * //Initialize an instance of the ArcGISServerRestOverlay class.// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#ArcGISServerRestOverlay.28String.2C_Uri.2C_TileType.29// | ||
| - | == Parameters == | ||
| - | * //id// | ||
| - | * Type:String | ||
| - | * Description:The identifier string of the ArcGISServerRestOverlay. | ||
| - | |||
| - | * //serverUri// | ||
| - | * Type:Uri | ||
| - | * Description:The uri of the ArcGIS REST SERVER | ||
| - | |||
| - | * //tileType// | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] | ||
| - | * Description:The Tile Type of the layer | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Protected Constructors ==== | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} ToJson() ** | ||
| - | |||
| - | * //Returns a JSON string which contains the information for creating an overlay at the client side.// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#ToJson.28.29// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:A JSON string which is used to create an overlay at the client side. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#ToString.28.29// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Equals.28Object.29// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#GetHashCode.28.29// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#GetType.28.29// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //page// | ||
| - | * Type:Page | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //page// | ||
| - | * Type:Page | ||
| - | * Description:The page object that is used for registering the javascript library. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:EventArgs | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** | ||
| - | |||
| - | * //Raises the Tick event of the MarkerOverlay.// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#OnTick.28EventArgs.29// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:EventArgs | ||
| - | * Description:An System.EventArgs object that contains the event data. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Finalize.28.29// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#MemberwiseClone.28.29// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} Parameters ** | ||
| - | |||
| - | Gets a dictionary whose items will be passed to the ArcGIS REST Server server as parameters. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Parameters | ||
| - | == Return Value == | ||
| - | * Type:Dictionary<String,String> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Projection ** | ||
| - | |||
| - | Gets or sets a string that will be sent to the ArcGIS REST server to get the images in the specific projection. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Projection | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TileWidth ** | ||
| - | |||
| - | Gets or sets the width of each tile, if the WmsOverlay uses tiling. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#TileWidth | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TileHeight ** | ||
| - | |||
| - | Gets or sets the height of each tile, if the WmsOverlay uses tiling. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#TileHeight | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TransitionEffect ** | ||
| - | |||
| - | Gets or sets the transition effect to use when the map is zoomed. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#TransitionEffect | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TransitionEffectDelayInMilliseconds ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here: | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TileType ** | ||
| - | |||
| - | Gets or sets whether or not the ArcGISServerRestOverlay uses tiling. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#ArcGISServerRestOverlay.28String.2C_Uri.2C_TileType.29 | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ServerUri ** | ||
| - | |||
| - | Gets or sets the URI that specifies the locations of the ArcGIS Rest servers. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#ServerUri | ||
| - | == Return Value == | ||
| - | * Type:Uri | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsVisible ** | ||
| - | |||
| - | Gets or sets a value that indicates whether the overlay is visible on the map. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#IsVisible | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | |||
| - | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Name | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** | ||
| - | |||
| - | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#IsVisibleInOverlaySwitcher | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** | ||
| - | |||
| - | Gets or sets a value that indicates whether the overlay is a base overlay. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#IsBaseOverlay | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Id ** | ||
| - | |||
| - | Gets the identifier for the overlay to be found. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Id | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ||
| - | |||
| - | Gets or sets the time interval in which the MarkerOverlay refreshes itself. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#AutoRefreshInterval | ||
| - | == Return Value == | ||
| - | * Type:TimeSpan | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Attribution | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} OverlayType ** | ||
| - | |||
| - | Gets a string that indicates the overlay type. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#OverlayType | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** | ||
| - | |||
| - | Don't support auto tick event by default. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#HasTickEvent | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} 3hM= ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Double | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ** {{wiki:PublicEvent.gif|}} Tick ** | ||
| - | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. | ||
| - | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#OnTick.28EventArgs.29 | ||
| - | |||
| - | Event Arguments:EventArgs | ||
| - | |||
8501 Wade Blvd Ste 550
Frisco, TX 75034
United States
sales@thinkgeo.com
1-785-727-4133
Online Store
- Desktop
WPF
WinForms
- Web
WebAPI HTML5/JavaScript
ASP.NET MVC
WebForms with AJAX
- Mobile
iOS
Android™
World Street
World Imagery
Routing
Geocoding
Reverse Geocoding
Elevation
Quick Start Guides
Documentation
Blogs
Discussion Forums
Customer Portal
About Us
News & Announcemets
Privacy Policy
Copyright 2003-2017 ThinkGeo LLC.
All rights reserved.