Table of Contents
ThinkGeo.MapSuite.WebEdition.Overlay
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
Serves as the base class that defines the properties and methods shared by all types of overlays.
Inheritance Hierarchy
- System.Object
- ThinkGeo.MapSuite.WebEdition.Overlay
Members Summary
Public Constructors
Protected Constructors
Overlay()
Initialize an instance of the Overlay class.
Remarks
N/A
Parameters
Overlay(String)
Initialize an instance of the Overlay class.
Remarks
N/A
Parameters
- id
- Type:String
- Description:N/A
Overlay(String,Boolean)
Initialize an instance of the Overlay class.
Remarks
N/A
Parameters
- id
- Type:String
- Description:N/A
- isBaseOverlay
- Type:Boolean
- Description:N/A
Public Methods
ToJson()
Returns a JSON string which contains the information for creating an overlay at the client side.
Remarks
N/A
Return Value
- Type:String
- Description:A JSON string which is used to create an overlay at the client side.
Parameters
ToString()
N/A
Remarks
N/A
Return Value
- Type:String
- Description:N/A
Parameters
Equals(Object)
N/A
Remarks
N/A
Return Value
- Type:Boolean
- Description:N/A
Parameters
- obj
- Type:Object
- Description:N/A
GetHashCode()
N/A
Remarks
N/A
Return Value
- Type:Int32
- Description:N/A
Parameters
GetType()
N/A
Remarks
N/A
Return Value
- Type:Type
- Description:N/A
Parameters
Protected Methods
3xM=(Page)
N/A
Remarks
N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- page
- Type:Page
- Description:N/A
RegisterJavaScriptLibraryCore(Page)
Registers a Javascript library URL string to the client HTML page.
Remarks
The RegisterJavaScriptLibraryCore 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.
RaiseTickEvent(EventArgs)
N/A
Remarks
N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- e
- Type:EventArgs
- Description:N/A
OnTick(EventArgs)
Raises the Tick event of the MarkerOverlay.
Remarks
N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- e
- Type:EventArgs
- Description:An System.EventArgs object that contains the event data.
Finalize()
N/A
Remarks
N/A
Return Value
- Type:Void
- Description:N/A
Parameters
MemberwiseClone()
N/A
Remarks
N/A
Return Value
- Type:Object
- Description:N/A
Parameters
Public Properties
IsVisible
Gets or sets a value that indicates whether the overlay is visible on the map.
Remarks
N/A
Return Value
- Type:Boolean
Name
Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
Remarks
N/A
Return Value
- Type:String
Opacity
Gets or sets the opacity level of the overlay.
Remarks
The Opacity 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
IsVisibleInOverlaySwitcher
Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
Remarks
N/A
Return Value
- Type:Boolean
IsBaseOverlay
Gets or sets a value that indicates whether the overlay is a base overlay.
Remarks
N/A
Return Value
- Type:Boolean
Id
Gets the identifier for the overlay to be found.
Remarks
N/A
Return Value
- Type:String
AutoRefreshInterval
Gets or sets the time interval in which the MarkerOverlay refreshes itself.
Remarks
N/A
Return Value
- Type:TimeSpan
Attribution
N/A
Remarks
N/A
Return Value
- Type:String
Protected Properties
OverlayType
Gets a string that indicates which type the overlay is.
Remarks
N/A
Return Value
- Type:String
HasTickEvent
Indicates whether the overlay supports tick event.
Remarks
N/A
Return Value
- Type:Boolean
3hM=
N/A
Remarks
N/A
Return Value
- Type:Double
Public Events
Tick
Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.
Remarks
N/A
Event Arguments:EventArgs