User Tools

Site Tools


thinkgeo.mapsuite.webedition.adornmentoverlay

ThinkGeo.MapSuite.WebEdition.AdornmentOverlay

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.

This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl.

Inheritance Hierarchy

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

Members Summary

Public Constructors

AdornmentOverlay()

  • Initialize an instance of the AdornmentOverlay class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AdornmentOverlay.28.29
Parameters

AdornmentOverlay(String)

  • Initialize an instance of the AdornmentOverlay class with the overlay identifier specified.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AdornmentOverlay.28String.29
Parameters
  • id
    • Type:String
    • Description:The identifier string used to retrieve the overlay for collection.

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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Draw.28GeoCanvas.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter specifies the target canvas to draw the current AdornmentOverlay on.

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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#ToJson.28.29
Return Value
  • Type:String
  • Description:A JSON string which is used to create an overlay at the client side.
Parameters

ToString()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#ToString.28.29
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Equals.28Object.29
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#GetHashCode.28.29
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#GetType.28.29
Return Value
  • Type:Type
  • Description:N/A
Parameters

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:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#DrawCore.28GeoCanvas.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter specifies the target canvas to draw the current AdornmentOverlay on.

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 <strong>RegisterJavaScriptLibraryCore</strong> 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
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OnTick.28EventArgs.29
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
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Finalize.28.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#MemberwiseClone.28.29
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Layers

Return Value

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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsVisible

Return Value
  • Type:Boolean

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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Name

Return Value
  • Type:String

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
  • Type:Single

IsVisibleInOverlaySwitcher

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

Remarks
Return Value
  • Type:Boolean

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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsBaseOverlay

Return Value
  • Type:Boolean

Id

Gets the identifier for the overlay to be found.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Id

Return Value
  • Type:String

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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AutoRefreshInterval

Return Value
  • Type:TimeSpan

Attribution

N/A

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Attribution

Return Value
  • Type:String

Protected Properties

4RM=

N/A

Remarks

N/A

Return Value

OverlayType

Gets a string that indicates the overlay type.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OverlayType

Return Value
  • Type:String

HasTickEvent

Indicates whether the overlay supports tick event.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#HasTickEvent

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

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OnTick.28EventArgs.29

Event Arguments:EventArgs

thinkgeo.mapsuite.webedition.adornmentoverlay.txt · Last modified: 2017/03/16 21:59 (external edit)