thinkgeo.mapsuite.webedition.arcgisserverrestoverlay
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.arcgisserverrestoverlay [2015/09/18 03:07] admin |
thinkgeo.mapsuite.webedition.arcgisserverrestoverlay [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay ====== | ====== ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| 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 | 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 ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay() ** | ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay() ** | ||
| - | Initialize an instance of the ArcGISServerRestOverlay class with none parameter. | + | * //Initialize an instance of the ArcGISServerRestOverlay class with none parameter.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay(String) ** | ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay(String) ** | ||
| - | Initialize an instance of the ArcGISServerRestOverlay class. | + | * //Initialize an instance of the ArcGISServerRestOverlay class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 27: | Line 30: | ||
| ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay(String,Uri) ** | ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay(String,Uri) ** | ||
| - | Initialize an instance of the ArcGISServerRestOverlay class. | + | * //Initialize an instance of the ArcGISServerRestOverlay class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 42: | Line 45: | ||
| ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay(String,Uri,TileType) ** | ** {{wiki:PublicMethod.gif|}} ArcGISServerRestOverlay(String,Uri,TileType) ** | ||
| - | Initialize an instance of the ArcGISServerRestOverlay class. | + | * //Initialize an instance of the ArcGISServerRestOverlay class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 63: | Line 66: | ||
| ** {{wiki:PublicMethod.gif|}} ToJson() ** | ** {{wiki:PublicMethod.gif|}} ToJson() ** | ||
| - | N/A | + | * //Returns a JSON string which contains the information for creating an overlay at the client side.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Return Value == | ||
| * Type:String | * Type:String | ||
| - | * Description:N/A | + | * Description:A JSON string which is used to create an overlay at the client side. |
| == Parameters == | == Parameters == | ||
| Line 75: | Line 78: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Return Value == | ||
| Line 87: | Line 90: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Return Value == | ||
| Line 103: | Line 106: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Return Value == | ||
| Line 115: | Line 118: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Return Value == | ||
| Line 128: | Line 131: | ||
| ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 144: | Line 147: | ||
| ** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** | ** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** | ||
| - | N/A | + | * //Registers a Javascript library URL string to the client HTML page.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //The <strong>RegisterJavaScriptLibraryCore</strong> method allows derived classes to override and register their own Javascript library URL to the HTML page.// |
| == Return Value == | == Return Value == | ||
| Line 155: | Line 158: | ||
| * //page// | * //page// | ||
| * Type:Page | * Type:Page | ||
| - | * Description:N/A | + | * Description:The page object that is used for registering the javascript library. |
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 176: | Line 179: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** | ||
| - | N/A | + | * //Raises the Tick event of the MarkerOverlay.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Return Value == | ||
| Line 187: | Line 190: | ||
| * //e// | * //e// | ||
| * Type:EventArgs | * Type:EventArgs | ||
| - | * Description:N/A | + | * Description:An System.EventArgs object that contains the event data. |
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Return Value == | ||
| Line 204: | Line 207: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //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 == | == Return Value == | ||
| Line 219: | Line 222: | ||
| Gets a dictionary whose items will be passed to the ArcGIS REST Server server as parameters. | Gets a dictionary whose items will be passed to the ArcGIS REST Server server as parameters. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Parameters |
| == Return Value == | == Return Value == | ||
| * Type:Dictionary<String,String> | * Type:Dictionary<String,String> | ||
| Line 227: | Line 230: | ||
| Gets or sets a string that will be sent to the ArcGIS REST server to get the images in the specific projection. | Gets or sets a string that will be sent to the ArcGIS REST server to get the images in the specific projection. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Projection |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 235: | Line 238: | ||
| Gets or sets the width of each tile, if the WmsOverlay uses tiling. | Gets or sets the width of each tile, if the WmsOverlay uses tiling. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#TileWidth |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 243: | Line 246: | ||
| Gets or sets the height of each tile, if the WmsOverlay uses tiling. | Gets or sets the height of each tile, if the WmsOverlay uses tiling. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#TileHeight |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 251: | Line 254: | ||
| Gets or sets the transition effect to use when the map is zoomed. | Gets or sets the transition effect to use when the map is zoomed. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#TransitionEffect |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]] | * Type:[[ThinkGeo.MapSuite.WebEdition.TransitionEffect|TransitionEffect]] | ||
| Line 259: | Line 262: | ||
| N/A | N/A | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here: |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 267: | Line 270: | ||
| Gets or sets whether or not the ArcGISServerRestOverlay uses tiling. | Gets or sets whether or not the ArcGISServerRestOverlay uses tiling. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | 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 == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] | * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] | ||
| Line 275: | Line 278: | ||
| Gets or sets the URI that specifies the locations of the ArcGIS Rest servers. | Gets or sets the URI that specifies the locations of the ArcGIS Rest servers. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#ServerUri |
| == Return Value == | == Return Value == | ||
| * Type:Uri | * Type:Uri | ||
| Line 281: | Line 284: | ||
| ** {{wiki:PublicProperty.gif|}} IsVisible ** | ** {{wiki:PublicProperty.gif|}} IsVisible ** | ||
| - | N/A | + | Gets or sets a value that indicates whether the overlay is visible on the map. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#IsVisible |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 289: | Line 292: | ||
| ** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | N/A | + | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Name |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 297: | Line 300: | ||
| ** {{wiki:PublicProperty.gif|}} Opacity ** | ** {{wiki:PublicProperty.gif|}} Opacity ** | ||
| - | N/A | + | Gets or sets the opacity level of the overlay. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | 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 Value == | ||
| * Type:Single | * Type:Single | ||
| Line 305: | Line 308: | ||
| ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** | ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** | ||
| - | N/A | + | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#IsVisibleInOverlaySwitcher |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 313: | Line 316: | ||
| ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** | ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** | ||
| - | N/A | + | Gets or sets a value that indicates whether the overlay is a base overlay. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#IsBaseOverlay |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 321: | Line 324: | ||
| ** {{wiki:PublicProperty.gif|}} Id ** | ** {{wiki:PublicProperty.gif|}} Id ** | ||
| - | N/A | + | Gets the identifier for the overlay to be found. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Id |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 329: | Line 332: | ||
| ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ||
| - | N/A | + | Gets or sets the time interval in which the MarkerOverlay refreshes itself. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#AutoRefreshInterval |
| == Return Value == | == Return Value == | ||
| * Type:TimeSpan | * Type:TimeSpan | ||
| Line 339: | Line 342: | ||
| N/A | N/A | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#Attribution |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 348: | Line 351: | ||
| Gets a string that indicates the overlay type. | Gets a string that indicates the overlay type. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#OverlayType |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 356: | Line 359: | ||
| Don't support auto tick event by default. | Don't support auto tick event by default. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.ArcGISServerRestOverlay#HasTickEvent |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 370: | Line 373: | ||
| ==== Public Events ==== | ==== Public Events ==== | ||
| ** {{wiki:PublicEvent.gif|}} Tick ** | ** {{wiki:PublicEvent.gif|}} Tick ** | ||
| - | N/A | + | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | 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 | Event Arguments:EventArgs | ||
thinkgeo.mapsuite.webedition.arcgisserverrestoverlay.1442545622.txt.gz ยท Last modified: 2015/09/18 03:07 by admin