User Tools

Site Tools

Trace: • map_suit_ios_edition_videos_screenshots • thinkgeo.mapsuite.webedition.adornmentoverlay

Sidebar

ThinkGeo Cloud

ThinkGeo UI Controls

ThinkGeo Open Source

Help and Support

External Resources

thinkgeo.mapsuite.webedition.adornmentoverlay

This is an old revision of the document!

Table of Contents

ThinkGeo.MapSuite.WebEdition.AdornmentOverlay

<!– Class –> This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay</a>

Inheritance Hierarchy

*System.Object ThinkGeo.MapSuite.WebEdition.Overlay *ThinkGeo.MapSuite.WebEdition.AdornmentOverlay

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodAdornmentOverlay Initialize an instance of the AdornmentOverlay class.
Public MethodAdornmentOverlay 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
Public MethodDraw GeoCanvas Draw all of the layers to the image object using the parameters specified.
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodToJson Overlay 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 MethodDrawCore 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.
Protected MethodFinalize Object
Protected MethodMemberwiseClone Object
Protected MethodOnTick EventArgs Overlay Raises the Tick event of the MarkerOverlay.
Protected MethodRegisterJavaScriptLibraryCore Page Overlay Registers a Javascript library URL string to the client HTML page.

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Overlay
Public PropertyAutoRefreshInterval TimeSpan Overlay Gets or sets the time interval in which the MarkerOverlay refreshes itself.
Public PropertyId String Overlay Gets the identifier for the overlay to be found.
Public PropertyIsBaseOverlay Boolean Overlay Gets or sets a value that indicates whether the overlay is a base overlay.
Public PropertyIsVisible Boolean Overlay Gets or sets a value that indicates whether the overlay is visible on the map.
Public PropertyIsVisibleInOverlaySwitcher Boolean Overlay Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.
Public PropertyLayers GeoCollection<AdornmentLayer> This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.
Public PropertyName String Overlay Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
Public PropertyOpacity Single Overlay Gets or sets the opacity level of the overlay.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyHasTickEvent Boolean Overlay Indicates whether the overlay supports tick event.
Protected PropertyOverlayType String Overlay(overriden) Gets a string that indicates the overlay type.

Public Events

Name Event Arguments DeclaringType Summary
Public EventTick EventArgs Overlay Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.

Public Constructors

AdornmentOverlay()

Initialize an instance of the AdornmentOverlay class.

Overloads

Initialize an instance of the AdornmentOverlay class.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AdornmentOverlay.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AdornmentOverlay.28.29</a>

Parameters

Name Type Description

Go Back

AdornmentOverlay(String)

Initialize an instance of the AdornmentOverlay class with the overlay identifier specified.

Overloads

Initialize an instance of the AdornmentOverlay class.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AdornmentOverlay.28String.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AdornmentOverlay.28String.29</a>

Parameters

Name Type Description
id String<!– System.String –> The identifier string used to retrieve the overlay for collection.

Go Back

Protected Constructors

Public Methods

Draw(GeoCanvas)

Draw all of the layers to the image object using the parameters specified.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Draw.28GeoCanvas.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Draw.28GeoCanvas.29</a>

Return Value

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

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> This parameter specifies the target canvas to draw the current AdornmentOverlay on.

<!– ThinkGeo.MapSuite.WebEdition.AdornmentOverlay –> Go Back

Equals(Object)

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Equals.28Object.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Equals.28Object.29</a>

Return Value

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

Parameters

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

<!– System.Object –> Go Back

GetHashCode()

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#GetHashCode.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#GetHashCode.28.29</a>

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#GetType.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#GetType.28.29</a>

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.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#ToJson.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#ToJson.28.29</a>

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.WebEdition.Overlay –> Go Back

ToString()

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#ToString.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#ToString.28.29</a>

Return Value

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

Parameters

Name Type Description

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

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#DrawCore.28GeoCanvas.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#DrawCore.28GeoCanvas.29</a>

Return Value

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

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> This parameter specifies the target canvas to draw the current AdornmentOverlay on.

<!– ThinkGeo.MapSuite.WebEdition.AdornmentOverlay –> Go Back

Finalize()

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Finalize.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Finalize.28.29</a>

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

MemberwiseClone()

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#MemberwiseClone.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#MemberwiseClone.28.29</a>

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

OnTick(EventArgs)

Raises the Tick event of the MarkerOverlay.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OnTick.28EventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OnTick.28EventArgs.29</a>

Return Value

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

Parameters

Name Type Description
e EventArgs<!– System.EventArgs –> An System.EventArgs object that contains the event data.

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

RegisterJavaScriptLibraryCore(Page)

Registers a Javascript library URL string to the client HTML page.

Remarks

The &lt;strong&gt;RegisterJavaScriptLibraryCore&lt;/strong&gt; 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.WebEdition.Overlay –> Go Back

Public Properties

Attribution

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Attribution” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Attribution</a>

Return Value

Return Type
String<!– System.String –>

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

AutoRefreshInterval

Gets or sets the time interval in which the MarkerOverlay refreshes itself.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AutoRefreshInterval” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AutoRefreshInterval</a>

Return Value

Return Type
TimeSpan<!– System.TimeSpan –>

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

Id

Gets the identifier for the overlay to be found.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Id” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Id</a>

Return Value

Return Type
String<!– System.String –>

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

IsBaseOverlay

Gets or sets a value that indicates whether the overlay is a base overlay.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsBaseOverlay” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsBaseOverlay</a>

Return Value

Return Type
Boolean<!– System.Boolean –>

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

IsVisible

Gets or sets a value that indicates whether the overlay is visible on the map.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsVisible” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsVisible</a>

Return Value

Return Type
Boolean<!– System.Boolean –>

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

IsVisibleInOverlaySwitcher

Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsVisibleInOverlaySwitcher” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsVisibleInOverlaySwitcher</a>

Return Value

Return Type
Boolean<!– System.Boolean –>

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

Layers

This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Layers” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Layers</a>

Return Value

Return Type
GeoCollection<AdornmentLayer><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.AdornmentLayer} –>

<!– ThinkGeo.MapSuite.WebEdition.AdornmentOverlay –> Go Back

Name

Gets or sets the name of the overlay, which will display in the OverlaySwitcher.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Name” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Name</a>

Return Value

Return Type
String<!– System.String –>

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

Opacity

Gets or sets the opacity level of the overlay.

Remarks

The &lt;strong&gt;Opacity&lt;/strong&gt; 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.WebEdition.Overlay –> Go Back

Protected Properties

HasTickEvent

Indicates whether the overlay supports tick event.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#HasTickEvent” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#HasTickEvent</a>

Return Value

Return Type
Boolean<!– System.Boolean –>

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

OverlayType

Gets a string that indicates the overlay type.

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OverlayType” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OverlayType</a>

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WebEdition.Overlay(overriden) –> Go Back

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

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OnTick.28EventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OnTick.28EventArgs.29</a>

Event Arguments

Event Arguments
EventArgs<!– System.EventArgs –>

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

NOTOC WebEdition ThinkGeo.MapSuite.WebEdition UpdateDocumentation

thinkgeo.mapsuite.webedition.adornmentoverlay.1440040135.txt.gz · Last modified: 2015/09/18 03:06 (external edit)

Page Tools