User Tools

Site Tools


thinkgeo.mapsuite.webedition.simplemarkeroverlay

This is an old revision of the document!


ThinkGeo.MapSuite.WebEdition.SimpleMarkerOverlay

<!– Class –> Represents a MarkerOverlay object to which you can add markers directly.

Remarks

The &lt;strong&gt;SimpleMarkerOverlay&lt;/strong&gt; class has a &lt;strong&gt;Markers&lt;/strong&gt; collection to which you can add markers directly. All of these markers will be serialized to the client during the map loading. You can also specify whether the markers can be dragged by setting the &lt;strong&gt;DragMode&lt;/strong&gt; property.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodSimpleMarkerOverlay Initialize an instance of the SimpleMarkerOverlay class.
Public MethodSimpleMarkerOverlay String Initialize an instance of the SimpleMarkerOverlay class with the specified identifier of this overlay.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetMarkers RectangleShape, Int32 MarkerOverlay Returns a collection of markers based on the extent and zoomlevel that you passed in.
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 MethodFinalize Object
Protected MethodGetMarkersCore RectangleShape, Int32 MarkerOverlay(overriden) Returns a collection of markers that are within the specified worldExtent in this SimpleMarkerOverlay.
Protected MethodMemberwiseClone Object
Protected MethodOnClick MarkerOverlayClickEventArgs MarkerOverlay Raises the Click event of the MarkerOverlay object.
Protected MethodOnMarkerDragged MarkerDraggedEventArgs Triggers when the marker drag action ends.
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 PropertyDragMode MarkerDragMode Gets a value that specifies how the markers can be dragged.
Public PropertyId String Overlay Gets the identifier for the overlay to be found.
Public PropertyIsBaseOverlay Boolean Overlay(overriden)
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 PropertyMarkers GeoKeyedCollection<Marker> Gets a collection of markers that are serialized to the client.
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 PropertyHasMarkerDraggedEvent Boolean Gets a flag that check whether it raise an drag event on the client side.
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 EventClick MarkerOverlayClickEventArgs MarkerOverlay Occurs when a marker in the overlay is clicked.
Public EventMarkerDragged MarkerDraggedEventArgs Triggers when the marker drag action ends.
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

SimpleMarkerOverlay()

Initialize an instance of the SimpleMarkerOverlay class.

Overloads

Initialize an instance of the SimpleMarkerOverlay class.

Remarks

Parameters

Name Type Description

Go Back

SimpleMarkerOverlay(String)

Initialize an instance of the SimpleMarkerOverlay class with the specified identifier of this overlay.

Overloads

Initialize an instance of the SimpleMarkerOverlay class.

Remarks

Parameters

Name Type Description
id String<!– System.String –> The identifier string of the SimpleMarkerOverlay.

Go Back

Protected Constructors

Public Methods

Equals(Object)

Remarks

Return Value

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

Parameters

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

<!– System.Object –> Go Back

GetHashCode()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetMarkers(RectangleShape, Int32)

Returns a collection of markers based on the extent and zoomlevel that you passed in.

Remarks

The &lt;strong&gt;GetMarkers&lt;/strong&gt; method creates the makrers based on the current zoomlevel, the specified extent and the special logic of the MarkerOverlay. The returned markers object will be serialized and sent to the client to create client markers.

Return Value

Return Type Description
Collection<Marker><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WebEdition.Marker} –> A collection of marker objects that will be serialized to the client.

Parameters

Name Type Description
worldExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> The extent that includes all of the markers you want to serialize.
currentZoomLevelId Int32<!– System.Int32 –> An int value that indicates which zoomlevel the map is currently at.

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

GetType()

Remarks

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

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

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

Finalize()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetMarkersCore(RectangleShape, Int32)

Returns a collection of markers that are within the specified worldExtent in this SimpleMarkerOverlay.

Remarks

This method is not used.

Return Value

Return Type Description
Collection<Marker><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WebEdition.Marker} –> A collection of marker objects.

Parameters

Name Type Description
worldExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> The extent that includes the markers.
currentZoomLevelId Int32<!– System.Int32 –> An int value that indicates which zoomlevel the map is currently at.

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

MemberwiseClone()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

OnClick(MarkerOverlayClickEventArgs)

Raises the Click event of the MarkerOverlay object.

Remarks

The &lt;strong&gt;OnClick&lt;/strong&gt; method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.&lt;strong&gt;Notes to Inheritors:&lt;/strong&gt; When overriding &lt;strong&gt;OnClick&lt;/strong&gt; in a derived class, be sure to call the base class's &lt;strong&gt;OnClick&lt;/strong&gt; method so that registered delegates receive the event.

Return Value

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

Parameters

Name Type Description
e MarkerOverlayClickEventArgs<!– ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs –> The MarkerOverlayClickEventArgs that contains event data.

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

OnMarkerDragged(MarkerDraggedEventArgs)

Triggers when the marker drag action ends.

Remarks

Return Value

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

Parameters

Name Type Description
e MarkerDraggedEventArgs<!– ThinkGeo.MapSuite.WebEdition.MarkerDraggedEventArgs –>

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

OnTick(EventArgs)

Raises the Tick event of the MarkerOverlay.

Remarks

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

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

Return Value

Return Type
TimeSpan<!– System.TimeSpan –>

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

DragMode

Gets a value that specifies how the markers can be dragged.

Remarks

Return Value

Return Type
MarkerDragMode<!– ThinkGeo.MapSuite.WebEdition.MarkerDragMode –>

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

Id

Gets the identifier for the overlay to be found.

Remarks

Return Value

Return Type
String<!– System.String –>

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

IsBaseOverlay

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

IsVisible

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

Remarks

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

Return Value

Return Type
Boolean<!– System.Boolean –>

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

Markers

Gets a collection of markers that are serialized to the client.

Remarks

Return Value

Return Type
GeoKeyedCollection<Marker><!– ThinkGeo.MapSuite.WebEdition.GeoKeyedCollection{ThinkGeo.MapSuite.WebEdition.Marker} –>

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

Name

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

Remarks

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

HasMarkerDraggedEvent

Gets a flag that check whether it raise an drag event on the client side.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

HasTickEvent

Indicates whether the overlay supports tick event.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

OverlayType

Gets a string that indicates the overlay type.

Remarks

Return Value

Return Type
String<!– System.String –>

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

Public Events

Click

Occurs when a marker in the overlay is clicked.

Remarks

Event Arguments

Event Arguments
MarkerOverlayClickEventArgs<!– ThinkGeo.MapSuite.WebEdition.MarkerOverlayClickEventArgs –>

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

MarkerDragged

Triggers when the marker drag action ends.

Remarks

Event Arguments

Event Arguments
MarkerDraggedEventArgs<!– ThinkGeo.MapSuite.WebEdition.MarkerDraggedEventArgs –>

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

Tick

Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.

Remarks

Event Arguments

Event Arguments
EventArgs<!– System.EventArgs –>

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

NOTOC WebEdition ThinkGeo.MapSuite.WebEdition UpdateDocumentation

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