thinkgeo.mapsuite.mvcedition.adornmentoverlay
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mvcedition.adornmentoverlay [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.MvcEdition.AdornmentOverlay ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.MvcEdition.Overlay]] | ||
| - | ***[[ThinkGeo.MapSuite.MvcEdition.AdornmentOverlay]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AdornmentOverlay()|AdornmentOverlay]] | | | Initialize an instance of the AdornmentOverlay class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AdornmentOverlay(String)|AdornmentOverlay]] | String | | Initialize an instance of the AdornmentOverlay class with the overlay identifier specified. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas)|Draw]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | | 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}}[[#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}}[[#DrawCore(GeoCanvas)|DrawCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|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. | | ||
| - | | {{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}}[[#Layers|Layers]] | [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]> | | This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. | | ||
| - | | {{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. | | ||
| - | |||
| - | ==== 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 ===== | ||
| - | ==== AdornmentOverlay() ==== | ||
| - | Initialize an instance of the AdornmentOverlay class. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the AdornmentOverlay class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== AdornmentOverlay(String) ==== | ||
| - | Initialize an instance of the AdornmentOverlay class with the overlay identifier specified. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the AdornmentOverlay class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | id | String<!-- System.String --> | The identifier string used to retrieve the overlay for collection. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== Draw(GeoCanvas) ==== | ||
| - | 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 --> | This parameter specifies the target canvas to draw the current AdornmentOverlay on. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.AdornmentOverlay --> | ||
| - | [[#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]] | ||
| - | ==== 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 ===== | ||
| - | ==== 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter specifies the target canvas to draw the current AdornmentOverlay on. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.AdornmentOverlay --> | ||
| - | [[#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 ===== | ||
| - | ==== 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]] | ||
| - | ==== Layers ==== | ||
| - | This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]><!-- ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.AdornmentLayer} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.AdornmentOverlay --> | ||
| - | [[#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]] | ||
| - | ===== 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.adornmentoverlay.1440040131.txt.gz ยท Last modified: 2015/09/21 03:32 (external edit)
