thinkgeo.mapsuite.webedition.adornmentoverlay
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.adornmentoverlay [2015/09/18 03:06] admin |
thinkgeo.mapsuite.webedition.adornmentoverlay [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.AdornmentOverlay ====== | ====== ThinkGeo.MapSuite.WebEdition.AdornmentOverlay ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl. | This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} AdornmentOverlay() ** | ** {{wiki:PublicMethod.gif|}} AdornmentOverlay() ** | ||
| - | Initialize an instance of the AdornmentOverlay class. | + | * //Initialize an instance of the AdornmentOverlay 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.AdornmentOverlay#AdornmentOverlay.28.29// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} AdornmentOverlay(String) ** | ** {{wiki:PublicMethod.gif|}} AdornmentOverlay(String) ** | ||
| - | Initialize an instance of the AdornmentOverlay class with the overlay identifier specified. | + | * //Initialize an instance of the AdornmentOverlay class with the overlay identifier specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AdornmentOverlay.28String.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 29: | Line 32: | ||
| ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas) ** | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas) ** | ||
| - | Draw all of the layers to the image object using the parameters specified. | + | * //Draw all of the layers to the image object using the parameters specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Draw.28GeoCanvas.29// |
| == Return Value == | == Return Value == | ||
| Line 45: | Line 48: | ||
| ** {{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.AdornmentOverlay#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 57: | Line 60: | ||
| ** {{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.AdornmentOverlay#ToString.28.29// |
| == Return Value == | == Return Value == | ||
| Line 69: | Line 72: | ||
| ** {{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.AdornmentOverlay#Equals.28Object.29// |
| == Return Value == | == Return Value == | ||
| Line 85: | Line 88: | ||
| ** {{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.AdornmentOverlay#GetHashCode.28.29// |
| == Return Value == | == Return Value == | ||
| Line 97: | Line 100: | ||
| ** {{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.AdornmentOverlay#GetType.28.29// |
| == Return Value == | == Return Value == | ||
| Line 110: | Line 113: | ||
| ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas) ** | ||
| - | This method overrides the DrawCore logic in the Overlay base class. Draw all of the AdornmentLayers to the image object using the parameters specified. | + | * //This method overrides the DrawCore logic in the Overlay base class. Draw all of the AdornmentLayers to the image object using the parameters specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#DrawCore.28GeoCanvas.29// |
| == Return Value == | == Return Value == | ||
| Line 126: | Line 129: | ||
| ** {{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 142: | Line 145: | ||
| ** {{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 153: | Line 156: | ||
| * //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 174: | Line 177: | ||
| ** {{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.AdornmentOverlay#OnTick.28EventArgs.29// |
| == Return Value == | == Return Value == | ||
| Line 185: | Line 188: | ||
| * //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.AdornmentOverlay#Finalize.28.29// |
| == Return Value == | == Return Value == | ||
| Line 202: | Line 205: | ||
| ** {{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.AdornmentOverlay#MemberwiseClone.28.29// |
| == Return Value == | == Return Value == | ||
| Line 217: | Line 220: | ||
| This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. | This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Layers |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.AdornmentLayer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.AdornmentLayer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | ||
| Line 223: | Line 226: | ||
| ** {{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.AdornmentOverlay#IsVisible |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 231: | Line 234: | ||
| ** {{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.AdornmentOverlay#Name |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 239: | Line 242: | ||
| ** {{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 247: | Line 250: | ||
| ** {{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.AdornmentOverlay#IsVisibleInOverlaySwitcher |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 255: | Line 258: | ||
| ** {{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.AdornmentOverlay#IsBaseOverlay |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 263: | Line 266: | ||
| ** {{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.AdornmentOverlay#Id |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 271: | Line 274: | ||
| ** {{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.AdornmentOverlay#AutoRefreshInterval |
| == Return Value == | == Return Value == | ||
| * Type:TimeSpan | * Type:TimeSpan | ||
| Line 281: | Line 284: | ||
| 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.AdornmentOverlay#Attribution |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 298: | Line 301: | ||
| 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.AdornmentOverlay#OverlayType |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 304: | Line 307: | ||
| ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** | ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** | ||
| - | N/A | + | Indicates whether the overlay supports tick event. |
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#HasTickEvent |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 320: | Line 323: | ||
| ==== 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.AdornmentOverlay#OnTick.28EventArgs.29 |
| Event Arguments:EventArgs | Event Arguments:EventArgs | ||
thinkgeo.mapsuite.webedition.adornmentoverlay.1442545618.txt.gz · Last modified: 2015/09/18 03:06 by admin