User Tools

Site Tools

Trace: • thinkgeo.mapsuite.mvcedition.featureoverlay

Sidebar

ThinkGeo Cloud

ThinkGeo UI Controls

ThinkGeo Open Source

Help and Support

External Resources

thinkgeo.mapsuite.mvcedition.featureoverlay

This is an old revision of the document!

Table of Contents

ThinkGeo.MapSuite.MvcEdition.FeatureOverlay

<!– Class –> Serves as the base class for the overlays that contain features and paint the features at client side.

Remarks

The <strong>FeatureOverlay</strong> class is the base class for the overlays that need to draw features at client side. An instance of <strong>FeatureOverlay</strong> corresponds to an OpenLayer's vector layer at the client side.

All features in the <strong>Features</strong> collection will be serialized to the client and drawn as the <strong>Style</strong> property specifies.

<strong>Note:</strong> The <strong>Features</strong> property exposes the internal features of the <strong>FeatureSource</strong> property.

The <strong>FeatureSource</strong> property provides you with a batch of properties and functions that affect its internal features.

The <strong>Columns</strong> collection defines the column names for the feature data. It will be used to fetch a certain column from the data.

The <strong>QueryTools</strong> and <strong>EditTools</strong> provide you an easy way to query or edit features.

Inheritance Hierarchy

*System.Object ThinkGeo.MapSuite.MvcEdition.Overlay *ThinkGeo.MapSuite.MvcEdition.FeatureOverlay ThinkGeo.MapSuite.MvcEdition.EditFeatureOverlay ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay

Members Summary

Public Constructors

Name Parameters DeclaringType Summary

Protected Constructors

Name Parameters DeclaringType Summary
Protected MethodFeatureOverlay This is constructor of FeatureOverlay class.
Protected MethodFeatureOverlay String This is constructor of FeatureOverlay class.
Protected MethodFeatureOverlay String, Boolean This is constructor of FeatureOverlay class.

Public Methods

Name Parameters DeclaringType Summary
Public MethodEquals Object Object
Public MethodFromJson String Overlay Load this object from a json string.
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 MethodFinalize Object
Protected MethodMemberwiseClone Object
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 PropertyColumns Collection<FeatureSourceColumn> Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data.
Public PropertyEditTools EditTools Gets the EditTools that allow you to easily edit features in the FeatureOverlay.
Public PropertyFeatureSource InMemoryFeatureSource Gets the FeatureSource of the FeatureOverlay.
Public PropertyFeatures GeoCollection<Feature> Gets a collection of features that will be serialized to the client for drawing and editing.
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 PropertyName String Overlay Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
Public PropertyOnClientAutoRefreshTick String Overlay 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 Overlay Gets or sets the opacity level of the overlay.
Public PropertyQueryTools QueryTools Gets the QueryTools that allow you to easily query features from the FeatureOverlay.
Public PropertyStyle FeatureOverlayStyle Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side.

Protected Properties

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

Public Events

Name Event Arguments DeclaringType Summary

Public Constructors

Protected Constructors

FeatureOverlay()

This is constructor of FeatureOverlay class.

Parameters

Name Type Description

Go Back

FeatureOverlay(String)

This is constructor of FeatureOverlay class.

Parameters

Name Type Description
id String<!– System.String –> A string value indicates the Id property of this object.

Go Back

FeatureOverlay(String, Boolean)

This is constructor of FeatureOverlay class.

Parameters

Name Type Description
id String<!– System.String –> A string value indicates the Id property of this object.
isBaseOverlay Boolean<!– System.Boolean –> A boolean value indicates whether this overlay is base overlay or not.

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

Columns

Gets a collection of FeatureSourceColumns, which specifies the column names of the feature data.

Return Value

Return Type
Collection<FeatureSourceColumn><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSourceColumn} –>

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

EditTools

Gets the EditTools that allow you to easily edit features in the FeatureOverlay.

Return Value

Return Type
EditTools<!– ThinkGeo.MapSuite.Core.EditTools –>

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

FeatureSource

Gets the FeatureSource of the FeatureOverlay.

Return Value

Return Type
InMemoryFeatureSource<!– ThinkGeo.MapSuite.Core.InMemoryFeatureSource –>

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

Features

Gets a collection of features that will be serialized to the client for drawing and editing.

Return Value

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

<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlay –> 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

QueryTools

Gets the QueryTools that allow you to easily query features from the FeatureOverlay.

Return Value

Return Type
QueryTools<!– ThinkGeo.MapSuite.Core.QueryTools –>

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

Style

Gets or sets a FeatureOverlayStyle object, which determines how the features are drawn at the client side.

Return Value

Return Type
FeatureOverlayStyle<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlayStyle –>

<!– ThinkGeo.MapSuite.MvcEdition.FeatureOverlay –> 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(overriden) –> Go Back

Public Events

NOTOC MvcEdition ThinkGeo.MapSuite.MvcEdition UpdateDocumentation

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

Page Tools