User Tools

Site Tools


thinkgeo.mapsuite.mvcedition.map

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.MvcEdition.Map

<!– Class –> This class represents the map control.

Remarks

To use the map control in your Mvc application, serveral basic properties are required. The most important step is adding overlays, which generates images and stacks them over each other to form a map image.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodMap Initializes a new instance of the Map class.
Public MethodMap String Initializes a new instance of the Map class with identifier.
Public MethodMap String, Unit, Unit Initializes a new instance of the Map class with identifier, map width, and map height specified.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodCenterAt PointShape Moves the center of the map to a specified point..
Public MethodCenterAt Double, Double Moves the center of the map to a point specified by the provided X, Y world coordinates.
Public MethodEquals Object Object
Public MethodFill String, String MvcControlBase Fill an instance based on the input model name according to the input entity string
Public MethodFill String MvcControlBase Fill an instance according to the input entity string
Public MethodFromJson String Load this object from a json string.
Public MethodGetBitmap Save this object to a bitmap
Public MethodGetBitmap Int32, Int32 Gets a bitmap image based on the current map settings with the specified width and height.
Public MethodGetHashCode Object
Public MethodGetScreenDistanceBetweenTwoWorldPoints PointShape, PointShape Gets the distance in pixels between two specified points in world coordinates.
Public MethodGetType Object
Public MethodGetWorldDistanceBetweenTwoScreenPoints ScreenPointF, ScreenPointF, DistanceUnit Gets the distance in the specified distance unit from two screen points.
Public MethodPan PanDirection, Int32 Moves the map by the specified direction and percentage of the current extent.
Public MethodPan Single, Int32 Moves the map by the specified angle and the percentage of the current extent.
Public MethodToScreenCoordinate PointShape Returns a screen point from a point shape in world coordinates.
Public MethodToScreenCoordinate Double, Double Returns a point shape in screen coordinates from the specified X, Y world coordinates.
Public MethodToString String MvcControlBase Convert current object based on mode name to an entity string.
Public MethodToString Object(overriden)
Public MethodToWorldCoordinate ScreenPointF Returns a point shape in world coordinates from a ScreenPointF structure.
Public MethodToWorldCoordinate Single, Single Returns a point shape in world coordinates from the specified X, Y screen coordinates.
Public MethodZoomIn Zooms the map in to the next zoomlevel.
Public MethodZoomOut Zooms the map out to the next zoomlevel.
Public MethodZoomTo PointShape, Double Zooms the map to the center point and the scale that you specify.
Public MethodZoomToMarkers IEnumerable<Marker> Changes the current extent to the extent that includes all of the markers passed in.
Public MethodZoomToScale Double Zoom the map to a specific scale.

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodFinalize Object
Protected MethodMemberwiseClone Object

Public Properties

Name Return DeclaringType Summary
Public PropertyActiveBaseOverlay Overlay Gets or sets the active base overlay.
Public PropertyAdornmentOverlay AdornmentOverlay This property gets or sets the adornment overlay in the MapControl.
Public PropertyBackgroundOverlay Overlay Gets or sets an Overlay object that displays as the background map by default.
Public PropertyClientScriptBlocks Dictionary<String,String> MvcControlBase Gets the client script blocks which will be registered to the page.
Public PropertyClientScriptFileNames Dictionary<String,String> MvcControlBase Gets the client script files which will be registered to the page.
Public PropertyContextMenu ContextMenu Gets or sets the shortcut menu associated with the map.
Public PropertyCurrentExtent RectangleShape Gets or sets the current extent of the map.
Public PropertyCurrentScale Double Gets or sets a double value that indicates the current scale of the map.
Public PropertyCursor CursorType Gets or sets the cursor that appears when the mouse pointer is over the map control.
Public PropertyCustomCursorUri Uri Gets and sets a custom cursor image URI for the mouse cursor to use when you select 'CursorType.Custom'.
Public PropertyCustomOverlays GeoKeyedCollection<Overlay> Gets an Overlay collection, into which you can add different types of overlays.
Public PropertyDynamicOverlay LayerOverlay Gets a LayerOverlay object that can overlap other overlays.
Public PropertyEditOverlay EditFeatureOverlay Gets an EditOverlay object, with which you can draw and edit shapes at the client.
Public PropertyGeoCanvas GeoCanvas
Public PropertyHeight Unit MvcControlBase Gets or sets the height of the control.
Public PropertyHeightInPixels Double Get the actual height, in pixels, of the map control.
Public PropertyHighlightOverlay HighlightFeatureOverlay Gets an HighlightFeatureOverlay object, which draws its features at the client side and can attach the specified click event and context menu to them.
Public PropertyHtmlAttributes Dictionary<String,String> MvcControlBase Gets the customized html attributes of the control.
Public PropertyId String MvcControlBase Gets the client id of the control, it will be calculated from Name property.
Public PropertyIsDefaultJavascriptLibraryDisabled Boolean Gets or sets whether the default javascript library is disabled or not.
Public PropertyMapBackground BackgroundLayer Gets or sets the BackgroundLayer object that paints the map background.
Public PropertyMapTools MapTools Gets an object that contains all types of map controls for configuration.
Public PropertyMapUnit GeographyUnit Gets or sets the GeographyUnit for the map.
Public PropertyMarkerOverlay InMemoryMarkerOverlay Gets an InMemoryMarkerOverlay object that renders markers by the specified features.
Public PropertyName String MvcControlBase Gets the unique identifier name of the control.
Public PropertyOnClientBaseOverlayChanged String Gets or sets the client-side script that executes when the current base overlay changes in the OverlaySwitcher.
Public PropertyOnClientClick String Gets or sets the client-side script that executes when you click on the map.
Public PropertyOnClientDoubleClick String Gets or sets the client-side script that executes when you double-click on the map.
Public PropertyOnClientDrawEnd String Gets or sets the client-side script that executes whenever a feature is drawn at the client.
Public PropertyOnClientEditEnd String Gets or sets the client-side script that executes whenever you finish editing a shape at the client.
Public PropertyOnClientExtentChanged String Gets or sets the client-side script that executes when the map extent changes.
Public PropertyOnClientPopupsRequested String
Public PropertyOnClientPopupsRequesting String
Public PropertyOnClientTrackShapeFinished String Gets or sets the client-side script that executes after tracking the shape.
Public PropertyPopups GeoKeyedCollection<Popup> Gets a Popup collection that holds all of the popups in the map.
Public PropertyResourceDeploymentMode ResourceDeploymentMode Gets or sets a value that indicates whether the application allows map to copy its resource images under “~/theme/default/img/” and a css file “~/theme/default/style.css”. The default value is “ResourceDeploymentMode.Automatically”, otherwise, you need to copy images to the directory.
Public PropertyRestrictedExtent RectangleShape Gets or sets an extent that limits the area to which the map can be navigated within.
Public PropertyStaticOverlay LayerOverlay Gets a LayerOverlay object that displays as a background map.
Public PropertyStyleSheetFileNames Collection<String> MvcControlBase Gets the css files which will be wrote to the client html.
Public PropertyStatic MemberVersion String Gets the version of the map control.
Public PropertyViewContext ViewContext MvcControlBase Gets the ViewContext of the page which includes the control.
Public PropertyVisible Boolean MvcControlBase Gets or sets the visibility of the control.
Public PropertyWebConfigRegisterMode WebConfigRegistrationMode Gets or sets a value that indicates whether the application allows map to register the Web.config on the fly in runtime. The default value is “WebConfigRegisterMode.AutoRegistered”, otherwise, you need to copy the code below to the web.config manually. … …
Public PropertyWidth Unit MvcControlBase Gets or sets the width of the control.
Public PropertyWidthInPixels Double Get the actual width, in pixels, of the map control.
Public PropertyZoomLevelSet ZoomLevelSet Gets or sets the ZoomLevelSet applied to the map.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyCenterX Double Gets or sets a double value for center X of current viewport.
Protected PropertyCenterY Double Gets or sets a double value for center Y of current viewport.
Protected PropertyClientResolutions Collection<Double> Gets the resolution collection corresponding to the specified ZoomLevelSets applied to the map.
Protected PropertyClientScriptManager MvcClientScriptManager MvcControlBase Gets the object which is used for managing, registering the client scripts.
Protected PropertyClientStyleSheetManager MvcClientStyleSheetManager MvcControlBase Gets the object which is used for managing, registering the css files used by the control.
Protected PropertyMaxExtent RectangleShape
Protected PropertyPageRootPath String Gets a string value indicats the web page's root path for loading the default icons.

Public Events

Name Event Arguments DeclaringType Summary

Public Constructors

Map()

Initializes a new instance of the Map class.

Overloads

Initializes a new instance of the Map class.

Parameters

Name Type Description

Go Back

Map(String)

Initializes a new instance of the Map class with identifier.

Overloads

The unique identifier name of the control.

Parameters

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

Go Back

Map(String, Unit, Unit)

Initializes a new instance of the Map class with identifier, map width, and map height specified.

Overloads

Initializes a new instance of the Map class.

Parameters

Name Type Description
name String<!– System.String –>
width Unit<!– System.Web.UI.WebControls.Unit –>
height Unit<!– System.Web.UI.WebControls.Unit –>

Go Back

Protected Constructors

Public Methods

CenterAt(PointShape)

Moves the center of the map to a specified point..

Overloads

Moves the center of the map to a specified destination.

Return Value

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

Parameters

Name Type Description
worldPoint PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> The target point in world coordinates to set as the center of the map's CurrentExtent.

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

CenterAt(Double, Double)

Moves the center of the map to a point specified by the provided X, Y world coordinates.

Overloads

Moves the center of the map to a specified destination.

Remarks

This method changes the map center to a point specified by the X, Y coordinates you provide.

Return Value

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

Parameters

Name Type Description
worldX Double<!– System.Double –> The X-value in world coordinates of the new center.
worldY Double<!– System.Double –> The Y-value in world coordinates of the new center.

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

Equals(Object)

Return Value

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

Parameters

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

<!– System.Object –> Go Back

Fill(String, String)

Fill an instance based on the input model name according to the input entity string

Return Value

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

Parameters

Name Type Description
modelName String<!– System.String –> the input model name
entityString String<!– System.String –> the input entity string

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

Fill(String)

Fill an instance according to the input entity string

Return Value

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

Parameters

Name Type Description
entityString String<!– System.String –> the inpu entity string.

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

GetBitmap()

Save this object to a bitmap

Return Value

Return Type Description
Bitmap<!– System.Drawing.Bitmap –> a bitmap

Parameters

Name Type Description

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

GetBitmap(Int32, Int32)

Gets a bitmap image based on the current map settings with the specified width and height.

Overloads

Gets a bitmap image of the map.

Remarks

This method generates a bitmap map image with the current map settings, using the image width and height that you specify.

Return Value

Return Type Description
Bitmap<!– System.Drawing.Bitmap –> A bitmap that is generated base on the current map settings.

Parameters

Name Type Description
width Int32<!– System.Int32 –> The width of bitmap.
height Int32<!– System.Int32 –> The height of bitmap.

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

GetHashCode()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetScreenDistanceBetweenTwoWorldPoints(PointShape, PointShape)

Gets the distance in pixels between two specified points in world coordinates.

Return Value

Return Type Description
Single<!– System.Single –> The lengh in pixels between the two points.

Parameters

Name Type Description
startPoint PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> The first point in world coordinates.
endpoint PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> The second point in world coordinates.

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

GetType()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetWorldDistanceBetweenTwoScreenPoints(ScreenPointF, ScreenPointF, DistanceUnit)

Gets the distance in the specified distance unit from two screen points.

Return Value

Return Type Description
Double<!– System.Double –> The distance value in the specified unit between two screen points.

Parameters

Name Type Description
startPoint ScreenPointF<!– ThinkGeo.MapSuite.Core.ScreenPointF –> The first point in screen coordinates.
endpoint ScreenPointF<!– ThinkGeo.MapSuite.Core.ScreenPointF –> The second point in screen coordinates.
unitOfDistance DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> The unit of return distance.

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

Pan(PanDirection, Int32)

Moves the map by the specified direction and percentage of the current extent.

Overloads

Moves the map by a certain offset.

Remarks

This method caculates the panning offset by the current extent and the percentage. If the percentage is 20, the panning offset in the X direction is <strong>CurrentExtent.Width* 0.2</strong> and the offset in the Y direction is <strong>CurrentExtent.Hight*0.2</strong>.

Return Value

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

Parameters

Name Type Description
panDirection PanDirection<!– ThinkGeo.MapSuite.Core.PanDirection –> Up, Down, Left, Right, UpperRight, LowerRight, UpperLeft, LowerLeft.
percentage Int32<!– System.Int32 –> The percentage of the current extent.

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

Pan(Single, Int32)

Moves the map by the specified angle and the percentage of the current extent.

Overloads

Moves the map by a certain offset.

Remarks

This method moves the map by the angle and the percentage that you specify.

The angle starts from the east and increases counterclockwise. For example, angle 0 represents precisely east and angle 90 represents precisely north.

The percentage specifies the offset related to the current extent. If the percentage is 20, the panning offset in the X direction is <strong>CurrentExtent.Width* 0.2</strong> and the offset in the Y direction is <strong>CurrentExtent.Hight*0.2</strong>.

Return Value

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

Parameters

Name Type Description
degree Single<!– System.Single –> The angle value that determines the panning direction.
percentage Int32<!– System.Int32 –> The percentage of the current extent.

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

ToScreenCoordinate(PointShape)

Returns a screen point from a point shape in world coordinates.

Overloads

Returns a screen point that is converted from the specified world coordinates.

Remarks

This method converts the coordinates of a point shape to a point in screen coordinates.

Return Value

Return Type Description
ScreenPointF<!– ThinkGeo.MapSuite.Core.ScreenPointF –> A screen point in pixels.

Parameters

Name Type Description
worldPoint PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> A point shape in world coordinates.

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

ToScreenCoordinate(Double, Double)

Returns a point shape in screen coordinates from the specified X, Y world coordinates.

Overloads

Returns a screen point that is converted from the specified world coordinates.

Remarks

This method converts X, Y world coordinates to a point in screen coordinates.

Return Value

Return Type Description
ScreenPointF<!– ThinkGeo.MapSuite.Core.ScreenPointF –> A screen point in pixels.

Parameters

Name Type Description
worldX Double<!– System.Double –> The X world coordinate.
worldY Double<!– System.Double –> The Y world coordinate.

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

ToString(String)

Convert current object based on mode name to an entity string.

Return Value

Return Type Description
String<!– System.String –> an entity string

Parameters

Name Type Description
modelName String<!– System.String –> model name

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

ToString()

Return Value

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

Parameters

Name Type Description

<!– System.Object(overriden) –> Go Back

ToWorldCoordinate(ScreenPointF)

Returns a point shape in world coordinates from a ScreenPointF structure.

Overloads

Returns a point shape in world coordinates from screen coordinates.

Remarks

This method converts a screen point to a point in world coordinates.

Return Value

Return Type Description
PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> A point shape in world coordinates.

Parameters

Name Type Description
screenPoint ScreenPointF<!– ThinkGeo.MapSuite.Core.ScreenPointF –> The point (in screen coordinates) to convert to world coordinates.

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

ToWorldCoordinate(Single, Single)

Returns a point shape in world coordinates from the specified X, Y screen coordinates.

Overloads

Returns a point shape in world coordinates from the specified screen coordinates.

Remarks

This method converts X, Y screen coordinates to a point shape in world coodinates.

Return Value

Return Type Description
PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> A point shape in world coordinates.

Parameters

Name Type Description
screenX Single<!– System.Single –> The X-value in pixels referenced to the screen origin.
screenY Single<!– System.Single –> The Y-value in pixels referenced to the screen origin.

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

ZoomIn()

Zooms the map in to the next zoomlevel.

Return Value

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

Parameters

Name Type Description

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

ZoomOut()

Zooms the map out to the next zoomlevel.

Return Value

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

Parameters

Name Type Description

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

ZoomTo(PointShape, Double)

Zooms the map to the center point and the scale that you specify.

Remarks

The map will be panned to the new center and zoomed to the scale that you specify. If the new scale is not within the scales of the zoomlevels, the map will snap to the nearest upper zoomlevel. Thus, the scale the map finally zooms to may not be exactly the same as the scale you specified.

Return Value

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

Parameters

Name Type Description
center PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> The new center point of the map.
scale Double<!– System.Double –> The new scale that the map will zoom to.

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

ZoomToMarkers(IEnumerable<Marker>)

Changes the current extent to the extent that includes all of the markers passed in.

Remarks

This method changes the map's current extent to the smallest BoundingBox that includes all of the markers you specified.

Return Value

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

Parameters

Name Type Description
markers IEnumerable<Marker><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.MvcEdition.Marker} –> The markers that will be included in the new extent.

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

ZoomToScale(Double)

Zoom the map to a specific scale.

Remarks

This method will not affect the center of the map. It zooms the map to the zoomlevel whose scale is larger and nearest to the scale specified. For example, if you specify a scale that is between two zoomlevels, the map will snap to the nearest upper zoomlevel. So the map's final scale might not be equal to the specified scale after you call this method.

Return Value

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

Parameters

Name Type Description
targetScale Double<!– System.Double –> The scale the map will zoom to.

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

Public Properties

ActiveBaseOverlay

Gets or sets the active base overlay.

Remarks

The map can contain multiple base overlays, though only one of them can be displayed at a time. The <strong>ActiveBaseOverlay</strong> property specifies the one that is currently displayed. When you switch the base overlays in the <strong>OverlaySwitcher</strong>, the currently selected overlay will be synchronized to this property after postback.

Return Value

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

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

AdornmentOverlay

This property gets or sets the adornment overlay in the MapControl.

Return Value

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

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

BackgroundOverlay

Gets or sets an Overlay object that displays as the background map by default.

Remarks

The background overlay is one of the base overlays of the map. It can only be the base overlay. If you set a non-base overlay to it, there will be an exception thrown. The background overlay is the active base overlay by default, if you do not set the <strong>ActiveBaseOverlay</strong> property.

Return Value

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

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

ClientScriptBlocks

Gets the client script blocks which will be registered to the page.

Return Value

Return Type
Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –>

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

ClientScriptFileNames

Gets the client script files which will be registered to the page.

Return Value

Return Type
Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –>

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

ContextMenu

Gets or sets the shortcut menu associated with the map.

Return Value

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

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

CurrentExtent

Gets or sets the current extent of the map.

Return Value

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

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

CurrentScale

Gets or sets a double value that indicates the current scale of the map.

Return Value

Return Type
Double<!– System.Double –>

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

Cursor

Gets or sets the cursor that appears when the mouse pointer is over the map control.

Return Value

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

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

CustomCursorUri

Gets and sets a custom cursor image URI for the mouse cursor to use when you select 'CursorType.Custom'.

Return Value

Return Type
Uri<!– System.Uri –>

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

CustomOverlays

Gets an Overlay collection, into which you can add different types of overlays.

Remarks

You can create any type of Overlay object and add it to the CustomOverlays collection. The CustomOverlays collection will disable the BackgroundOverlay, StaticOverlay, DynamicOverlay and MarkerOverlay properties. This means you have two options for using overlays: Either set those overlay properties, or use the CustomOverlays collection. The CustomOverlays collection has higher priority and is more flexible. By contrast, the overlay properties act as shortcut way to use overlays.

Return Value

Return Type
GeoKeyedCollection<Overlay><!– ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection{ThinkGeo.MapSuite.MvcEdition.Overlay} –>

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

DynamicOverlay

Gets a LayerOverlay object that can overlap other overlays.

Return Value

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

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

EditOverlay

Gets an EditOverlay object, with which you can draw and edit shapes at the client.

Return Value

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

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

GeoCanvas

Return Value

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

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

Height

Gets or sets the height of the control.

Return Value

Return Type
Unit<!– System.Web.UI.WebControls.Unit –>

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

HeightInPixels

Get the actual height, in pixels, of the map control.

Remarks

When you set your map's height with percentage values (for example, 100%), you might want to know the actual pixel height of your map at a given time. This property returns the map's pixel height as determined by the browser.

<strong>Note:</strong> When the map height is a percent value, the <strong>HeightInPixels</strong> is double.NaN only until a postback generates. When the page postbacks, the actual height of the map will be synchronized to this property.

Return Value

Return Type
Double<!– System.Double –>

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

HighlightOverlay

Gets an HighlightFeatureOverlay object, which draws its features at the client side and can attach the specified click event and context menu to them.

Remarks

The HighlightOverlay actually serializes all its features to the client for drawing. These are client features whose styles changes when you mouse over them, thus generating the mouse-over highlight effect.

<strong>Note:</strong> Performance may be slow when the features added to the HighlightOverlay contain many vertices, because serializing and drawing these features at the client side may take some time.

Return Value

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

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

HtmlAttributes

Gets the customized html attributes of the control.

Return Value

Return Type
Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –>

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

Id

Gets the client id of the control, it will be calculated from Name property.

Return Value

Return Type
String<!– System.String –>

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

IsDefaultJavascriptLibraryDisabled

Gets or sets whether the default javascript library is disabled or not.

Return Value

Return Type
Boolean<!– System.Boolean –>

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

MapBackground

Gets or sets the BackgroundLayer object that paints the map background.

Remarks

This property determines the background of the map. The map will use the brush defined on this BackgroundLayer to paint the background.

Return Value

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

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

MapTools

Gets an object that contains all types of map controls for configuration.

Return Value

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

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

MapUnit

Gets or sets the GeographyUnit for the map.

Return Value

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

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

MarkerOverlay

Gets an InMemoryMarkerOverlay object that renders markers by the specified features.

Remarks

The MarkerOverlay overlaps on the base overlay and other non-base overlays. It displays markers based on the features you add to it. If you want to render markers by feature source, use the FeatureSourceMarkerOverlay and add it to the CustomOverlays collection.

Return Value

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

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

Name

Gets the unique identifier name of the control.

Return Value

Return Type
String<!– System.String –>

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

OnClientBaseOverlayChanged

Gets or sets the client-side script that executes when the current base overlay changes in the OverlaySwitcher.

Remarks

There is a default parameter: e, which includes a parameter “baseLayer” which is the name of the layer

Return Value

Return Type
String<!– System.String –>

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

OnClientClick

Gets or sets the client-side script that executes when you click on the map.

Remarks

There is a default parameter:e, which includes one parameter: “worldXY”

Return Value

Return Type
String<!– System.String –>

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

OnClientDoubleClick

Gets or sets the client-side script that executes when you double-click on the map.

Remarks

There is a default parameter:e, which includes one parameter: “worldXY”

Return Value

Return Type
String<!– System.String –>

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

OnClientDrawEnd

Gets or sets the client-side script that executes whenever a feature is drawn at the client.

Remarks

The <strong>OnClientDrawEnd</strong> property holds the Javascript function that will be executed whenever you finish drawing a shape. The Javascript function takes one parameter, which is the feature that you just drew. You can use this parameter to add extra data to the feature (add to feature.fieldValues). You can then retrieve that extra data from the feature's ColumnValues collection after postback.

Return Value

Return Type
String<!– System.String –>

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

OnClientEditEnd

Gets or sets the client-side script that executes whenever you finish editing a shape at the client.

Remarks

The <strong>OnClientEditEnd</strong> property holds the Javascript function that will be executed whenever you finish editing a shape. The Javascript function takes one parameter, which is the feature that you just edited. You can use this parameter to edit the extra data of the feature (feature.fieldValues). You can then retrieve that extra data from the feature's ColumnValues collection after postback.

Return Value

Return Type
String<!– System.String –>

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

OnClientExtentChanged

Gets or sets the client-side script that executes when the map extent changes.

Remarks

There is a default parameter: e, which includes two parameters, “extent”, “scale”

Return Value

Return Type
String<!– System.String –>

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

OnClientPopupsRequested

Return Value

Return Type
String<!– System.String –>

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

OnClientPopupsRequesting

Return Value

Return Type
String<!– System.String –>

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

OnClientTrackShapeFinished

Gets or sets the client-side script that executes after tracking the shape.

Remarks

There is a default parameter: e, which represents the editing geometry in json format

Return Value

Return Type
String<!– System.String –>

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

Popups

Gets a Popup collection that holds all of the popups in the map.

Return Value

Return Type
GeoKeyedCollection<Popup><!– ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection{ThinkGeo.MapSuite.MvcEdition.Popup} –>

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

ResourceDeploymentMode

Gets or sets a value that indicates whether the application allows map to copy its resource images under “~/theme/default/img/” and a css file “~/theme/default/style.css”. The default value is “ResourceDeploymentMode.Automatically”, otherwise, you need to copy images to the directory.

Return Value

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

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

RestrictedExtent

Gets or sets an extent that limits the area to which the map can be navigated within.

Return Value

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

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

StaticOverlay

Gets a LayerOverlay object that displays as a background map.

Remarks

The StaticOverlay is a shortcut way for you to add a LayerOverlay to the map. It can only be the base overlay. It is not the active base overlay by default. You need to set it to the ActiveBaseOverlay property in order to display it.

Return Value

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

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

StyleSheetFileNames

Gets the css files which will be wrote to the client html.

Return Value

Return Type
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –>

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

Version

<!– static –> Gets the version of the map control.

Return Value

Return Type
String<!– System.String –>

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

ViewContext

Gets the ViewContext of the page which includes the control.

Return Value

Return Type
ViewContext<!– System.Web.Mvc.ViewContext –>

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

Visible

Gets or sets the visibility of the control.

Return Value

Return Type
Boolean<!– System.Boolean –>

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

WebConfigRegisterMode

Gets or sets a value that indicates whether the application allows map to register the Web.config on the fly in runtime. The default value is “WebConfigRegisterMode.AutoRegistered”, otherwise, you need to copy the code below to the web.config manually. … …

Return Value

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

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

Width

Gets or sets the width of the control.

Return Value

Return Type
Unit<!– System.Web.UI.WebControls.Unit –>

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

WidthInPixels

Get the actual width, in pixels, of the map control.

Remarks

When you set your map's width with percentage values (for example, 100%), you might want to know the actual pixel width of your map at a given time. This property returns the map's pixel width as determined by the browser.

<strong>Note:</strong> When the map width is a percent value, the <strong>WidthInPixels</strong> is double.NaN only until a postback generates. When the page postbacks, the actual width of the map will be synchronized to this property.

Return Value

Return Type
Double<!– System.Double –>

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

ZoomLevelSet

Gets or sets the ZoomLevelSet applied to the map.

Return Value

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

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

Protected Properties

CenterX

Gets or sets a double value for center X of current viewport.

Return Value

Return Type
Double<!– System.Double –>

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

CenterY

Gets or sets a double value for center Y of current viewport.

Return Value

Return Type
Double<!– System.Double –>

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

ClientResolutions

Gets the resolution collection corresponding to the specified ZoomLevelSets applied to the map.

Return Value

Return Type
Collection<Double><!– System.Collections.ObjectModel.Collection{System.Double} –>

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

ClientScriptManager

Gets the object which is used for managing, registering the client scripts.

Return Value

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

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

ClientStyleSheetManager

Gets the object which is used for managing, registering the css files used by the control.

Return Value

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

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

MaxExtent

Return Value

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

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

PageRootPath

Gets a string value indicats the web page's root path for loading the default icons.

Return Value

Return Type
String<!– System.String –>

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

Public Events

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