User Tools

Site Tools

Trace: • thinkgeo.mapsuite.mvcedition.overlay

Sidebar

ThinkGeo Cloud

ThinkGeo UI Controls

ThinkGeo Open Source

Help and Support

External Resources

thinkgeo.mapsuite.mvcedition.overlay

This is an old revision of the document!

Table of Contents

ThinkGeo.MapSuite.MvcEdition.Overlay

<!– Class –> Serves as the base class that defines the properties and methods shared by all types of overlays.

Remarks

The <strong>Overlay</strong> has as similar concept to the Layer. Different types of overlays stack over each other to form a map. An overlay object is responsible for getting the configuration information from the user and serializing it to a JSON string to control the client Javascript library, which creates the appropriate client layer.

Usually, an overlay represents an image with a transparent background that is laid upon other overlay, such as a <strong>LayerOverlay</strong> or <strong>WmsOverlay</strong>. While the <strong>MarkerOverlay</strong> will not be rendered as an image, it actually represents a <strong>div</strong> that holds several marker images at the client side.

There are basically two kinds of overlays: base overlays and non-base overlays.

A base overlay has its <strong>IsBaseOverlay</strong> property set to true. It is displayed as the background image of the map. In an <strong>OverlaySwitcher</strong>, there is a radio button beside its name. There can be only one base overlay displayed at a time. You can click the radio button to switch the base overlay that is displayed.

A non-base overlay has a false <strong>IsBaseOverlay</strong> property. These overlays can overlap the base overlay and/or each other. They are displayed in the <strong>OverlaySwitcher</strong> with a check box beside their name. You can click the check box to show or hide a specific overlay.

Inheritance Hierarchy

*System.Object ThinkGeo.MapSuite.MvcEdition.Overlay *ThinkGeo.MapSuite.MvcEdition.AdornmentOverlay *ThinkGeo.MapSuite.MvcEdition.ArcGISServerRestOverlay *ThinkGeo.MapSuite.MvcEdition.BingMapsOverlay *ThinkGeo.MapSuite.MvcEdition.EditFeatureOverlay *ThinkGeo.MapSuite.MvcEdition.FeatureOverlay *ThinkGeo.MapSuite.MvcEdition.FeatureSourceMarkerOverlay *ThinkGeo.MapSuite.MvcEdition.GoogleOverlay *ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay *ThinkGeo.MapSuite.MvcEdition.InMemoryMarkerOverlay *ThinkGeo.MapSuite.MvcEdition.LayerOverlay *ThinkGeo.MapSuite.MvcEdition.MarkerOverlay *ThinkGeo.MapSuite.MvcEdition.OpenStreetMapOverlay *ThinkGeo.MapSuite.MvcEdition.SimpleMarkerOverlay *ThinkGeo.MapSuite.MvcEdition.WmsOverlay *ThinkGeo.MapSuite.MvcEdition.WmtsOverlay ***ThinkGeo.MapSuite.MvcEdition.WorldMapKitWmsWebOverlay

Members Summary

Public Constructors

Name Parameters DeclaringType Summary

Protected Constructors

Name Parameters DeclaringType Summary
Protected MethodOverlay Initialize an instance of the Overlay class.
Protected MethodOverlay String Initialize an instance of the Overlay class.
Protected MethodOverlay String, Boolean Initialize an instance of the Overlay class.

Public Methods

Name Parameters DeclaringType Summary
Public MethodEquals Object Object
Public MethodFromJson String Load this object from a json string.
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodToJson Returns a JSON string which contains the information for creating an overlay at the client side.
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodFinalize Object
Protected MethodMemberwiseClone Object
Protected MethodRegisterJavaScriptLibraryCore Page Registers a Javascript library URL string to the client HTML page.

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String
Public PropertyAutoRefreshInterval TimeSpan Gets or sets the time interval in which the MarkerOverlay refreshes itself.
Public PropertyId String Gets the identifier for the overlay to be found.
Public PropertyIsBaseOverlay Boolean Gets or sets a value that indicates whether the overlay is a base overlay.
Public PropertyIsVisible Boolean Gets or sets a value that indicates whether the overlay is visible on the map.
Public PropertyIsVisibleInOverlaySwitcher Boolean Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
Public PropertyName String Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
Public PropertyOnClientAutoRefreshTick String Gets or sets a JavaScript function name which will be executed when the number of milliseconds specified in the AutoRefreshInterval property has elapsed.
Public PropertyOpacity Single Gets or sets the opacity level of the overlay.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyOverlayType String Gets a string that indicates which type the overlay is.

Public Events

Name Event Arguments DeclaringType Summary

Public Constructors

Protected Constructors

Overlay()

Initialize an instance of the Overlay class.

Overloads

Initialize an instance of the Overlay class.

Parameters

Name Type Description

Go Back

Overlay(String)

Initialize an instance of the Overlay class.

Overloads

Initialize an instance of the Overlay class.

Parameters

Name Type Description
id String<!– System.String –>

Go Back

Overlay(String, Boolean)

Initialize an instance of the Overlay class.

Overloads

Initialize an instance of the Overlay class.

Parameters

Name Type Description
id String<!– System.String –>
isBaseOverlay Boolean<!– System.Boolean –>

Go Back

Public Methods

Equals(Object)

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> 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 –> Go Back

GetHashCode()

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> 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 –> Go Back

ToString()

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

Finalize()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

MemberwiseClone()

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> 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 –> Go Back

Public Properties

Attribution

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> 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 –> Go Back

Id

Gets the identifier for the overlay to be found.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> 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 –> 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 –> 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 –> 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 –> 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 –> 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 –> Go Back

Protected Properties

OverlayType

Gets a string that indicates which type the overlay is.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> Go Back

Public Events

NOTOC MvcEdition ThinkGeo.MapSuite.MvcEdition UpdateDocumentation

thinkgeo.mapsuite.mvcedition.overlay.1440040131.txt.gz · Last modified: 2015/09/21 03:35 (external edit)

Page Tools