thinkgeo.mapsuite.mvcedition.map
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
thinkgeo.mapsuite.mvcedition.map [2015/09/22 08:34] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.MvcEdition.Map ====== | ||
| - | This class represents the map control. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | *ThinkGeo.MapSuite.MvcEdition.MvcControlBase | ||
| - | ***ThinkGeo.MapSuite.MvcEdition.Map** | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} Map() ** | ||
| - | |||
| - | * //Initializes a new instance of the Map class.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Map(String) ** | ||
| - | |||
| - | * //Initializes a new instance of the Map class with identifier.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | == Parameters == | ||
| - | * //name// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Map(String,Unit,Unit) ** | ||
| - | |||
| - | * //Initializes a new instance of the Map class with identifier, map width, and map height specified.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | == Parameters == | ||
| - | * //name// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //width// | ||
| - | * Type:Unit | ||
| - | * Description:N/A | ||
| - | |||
| - | * //height// | ||
| - | * Type:Unit | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Protected Constructors ==== | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(Double,Double) ** | ||
| - | |||
| - | * //Returns a point shape in screen coordinates from the specified X, Y world coordinates.// | ||
| - | == Remarks == | ||
| - | * //This method converts X, Y world coordinates to a point in screen coordinates.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | ||
| - | * Description:A screen point in pixels. | ||
| - | |||
| - | == Parameters == | ||
| - | * //worldX// | ||
| - | * Type:Double | ||
| - | * Description:The X world coordinate. | ||
| - | |||
| - | * //worldY// | ||
| - | * Type:Double | ||
| - | * Description:The Y world coordinate. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(PointShape) ** | ||
| - | |||
| - | * //Returns a screen point from a point shape in world coordinates.// | ||
| - | == Remarks == | ||
| - | * //This method converts the coordinates of a point shape to a point in screen coordinates.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | ||
| - | * Description:A screen point in pixels. | ||
| - | |||
| - | == Parameters == | ||
| - | * //worldPoint// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * Description:A point shape in world coordinates. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(Single,Single) ** | ||
| - | |||
| - | * //Returns a point shape in world coordinates from the specified X, Y screen coordinates.// | ||
| - | == Remarks == | ||
| - | * //This method converts X, Y screen coordinates to a point shape in world coodinates.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * Description:A point shape in world coordinates. | ||
| - | |||
| - | == Parameters == | ||
| - | * //screenX// | ||
| - | * Type:Single | ||
| - | * Description:The X-value in pixels referenced to the screen origin. | ||
| - | |||
| - | * //screenY// | ||
| - | * Type:Single | ||
| - | * Description:The Y-value in pixels referenced to the screen origin. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(ScreenPointF) ** | ||
| - | |||
| - | * //Returns a point shape in world coordinates from a ScreenPointF structure.// | ||
| - | == Remarks == | ||
| - | * //This method converts a screen point to a point in world coordinates.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * Description:A point shape in world coordinates. | ||
| - | |||
| - | == Parameters == | ||
| - | * //screenPoint// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | ||
| - | * Description:The point (in screen coordinates) to convert to world coordinates. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} CenterAt(PointShape) ** | ||
| - | |||
| - | * //Moves the center of the map to a specified point..// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //worldPoint// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * Description:The target point in world coordinates to set as the center of the map's CurrentExtent. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} CenterAt(Double,Double) ** | ||
| - | |||
| - | * //Moves the center of the map to a point specified by the provided X, Y world coordinates.// | ||
| - | == Remarks == | ||
| - | * //This method changes the map center to a point specified by the X, Y coordinates you provide.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //worldX// | ||
| - | * Type:Double | ||
| - | * Description:The X-value in world coordinates of the new center. | ||
| - | |||
| - | * //worldY// | ||
| - | * Type:Double | ||
| - | * Description:The Y-value in world coordinates of the new center. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //center// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * Description:The new center point of the map. | ||
| - | |||
| - | * //scale// | ||
| - | * Type:Double | ||
| - | * Description:The new scale that the map will zoom to. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ZoomIn() ** | ||
| - | |||
| - | * //Zooms the map in to the next zoomlevel.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ZoomOut() ** | ||
| - | |||
| - | * //Zooms the map out to the next zoomlevel.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //markers// | ||
| - | * Type:IEnumerable<[[ThinkGeo.MapSuite.MvcEdition.Marker|Marker]]> | ||
| - | * Description:The markers that will be included in the new extent. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //targetScale// | ||
| - | * Type:Double | ||
| - | * Description:The scale the map will zoom to. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetBitmap() ** | ||
| - | |||
| - | * //Save this object to a bitmap// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Bitmap | ||
| - | * Description:a bitmap | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetBitmap(Int32,Int32) ** | ||
| - | |||
| - | * //Gets a bitmap image based on the current map settings with the specified width and height.// | ||
| - | == Remarks == | ||
| - | * //This method generates a bitmap map image with the current map settings, using the image width and height that you specify.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Bitmap | ||
| - | * Description:A bitmap that is generated base on the current map settings. | ||
| - | |||
| - | == Parameters == | ||
| - | * //width// | ||
| - | * Type:Int32 | ||
| - | * Description:The width of bitmap. | ||
| - | |||
| - | * //height// | ||
| - | * Type:Int32 | ||
| - | * Description:The height of bitmap. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} FromJson(String) ** | ||
| - | |||
| - | * //Load this object from a json string.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //jsonString// | ||
| - | * Type:String | ||
| - | * Description:a json string | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetScreenDistanceBetweenTwoWorldPoints(PointShape,PointShape) ** | ||
| - | |||
| - | * //Gets the distance in pixels between two specified points in world coordinates.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | * Description:The lengh in pixels between the two points. | ||
| - | |||
| - | == Parameters == | ||
| - | * //startPoint// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * Description:The first point in world coordinates. | ||
| - | |||
| - | * //endpoint// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | * Description:The second point in world coordinates. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetWorldDistanceBetweenTwoScreenPoints(ScreenPointF,ScreenPointF,DistanceUnit) ** | ||
| - | |||
| - | * //Gets the distance in the specified distance unit from two screen points.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Double | ||
| - | * Description:The distance value in the specified unit between two screen points. | ||
| - | |||
| - | == Parameters == | ||
| - | * //startPoint// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | ||
| - | * Description:The first point in screen coordinates. | ||
| - | |||
| - | * //endpoint// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]] | ||
| - | * Description:The second point in screen coordinates. | ||
| - | |||
| - | * //unitOfDistance// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| - | * Description:The unit of return distance. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Pan(PanDirection,Int32) ** | ||
| - | |||
| - | * //Moves the map by the specified direction and percentage of the current extent.// | ||
| - | == 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 CurrentExtent.Width* 0.2 and the offset in the Y direction is CurrentExtent.Hight*0.2.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //panDirection// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.PanDirection|PanDirection]] | ||
| - | * Description:Up, Down, Left, Right, UpperRight, LowerRight, UpperLeft, LowerLeft. | ||
| - | |||
| - | * //percentage// | ||
| - | * Type:Int32 | ||
| - | * Description:The percentage of the current extent. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Pan(Single,Int32) ** | ||
| - | |||
| - | * //Moves the map by the specified angle and the percentage of the current extent.// | ||
| - | == 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 CurrentExtent.Width* 0.2 and the offset in the Y direction is CurrentExtent.Hight*0.2.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //degree// | ||
| - | * Type:Single | ||
| - | * Description:The angle value that determines the panning direction. | ||
| - | |||
| - | * //percentage// | ||
| - | * Type:Int32 | ||
| - | * Description:The percentage of the current extent. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Fill(String) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //entityString// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Fill(String,String) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //modelName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //entityString// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString(String) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //modelName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} LoadState() ** | ||
| - | |||
| - | * //Restores the control information from a persistent object the was saved by the SaveState method.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} PreRender() ** | ||
| - | |||
| - | * //Does the preparation before sending the Mvc control to the provided HtmlWriter of the ViewContext.// | ||
| - | == Remarks == | ||
| - | * //This method notifies the Mvc control to perform any necessary prerendering steps prior to rendering content and save state.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Render(HtmlTextWriter) ** | ||
| - | |||
| - | * //Sends the Mvc control content to a provided HtmlTextWriter object, which wirtes the content to be rendered on the client.// | ||
| - | == Remarks == | ||
| - | * //When developing a custom server control, you can override this method to generate conteol for a page.// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //htmlTextWriter// | ||
| - | * Type:HtmlTextWriter | ||
| - | * Description:The HtmlTextWriter object that receives the Mvc control content. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} SaveState() ** | ||
| - | |||
| - | * //Saves any necessary information of the Mvc control, which will be used in some other places.// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} GeoCanvas ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomLevelSet ** | ||
| - | |||
| - | Gets or sets the ZoomLevelSet applied to the map. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BackgroundLayer|BackgroundLayer]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ContextMenu ** | ||
| - | |||
| - | Gets or sets the shortcut menu associated with the map. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.ContextMenu|ContextMenu]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} CurrentExtent ** | ||
| - | |||
| - | Gets or sets the current extent of the map. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Cursor ** | ||
| - | |||
| - | Gets or sets the cursor that appears when the mouse pointer is over the map control. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.CursorType|CursorType]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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. ... ... | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.WebConfigRegistrationMode|WebConfigRegistrationMode]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.ResourceDeploymentMode|ResourceDeploymentMode]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} MapUnit ** | ||
| - | |||
| - | Gets or sets the GeographyUnit for the map. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 ActiveBaseOverlay property specifies the one that is currently displayed. When you switch the base overlays in the OverlaySwitcher, the currently selected overlay will be synchronized to this property after postback. | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} IsDefaultJavascriptLibraryDisabled ** | ||
| - | |||
| - | Gets or sets whether the default javascript library is disabled or not. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 ActiveBaseOverlay property. | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.LayerOverlay|LayerOverlay]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} DynamicOverlay ** | ||
| - | |||
| - | Gets a LayerOverlay object that can overlap other overlays. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.LayerOverlay|LayerOverlay]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.InMemoryMarkerOverlay|InMemoryMarkerOverlay]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection<T>[[ThinkGeo.MapSuite.MvcEdition.Overlay, MvcEdition, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoKeyedCollection<T>]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} EditOverlay ** | ||
| - | |||
| - | Gets an EditOverlay object, with which you can draw and edit shapes at the client. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.EditFeatureOverlay|EditFeatureOverlay]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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.Note: 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlay|HighlightFeatureOverlay]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} AdornmentOverlay ** | ||
| - | |||
| - | This property gets or sets the adornment overlay in the MapControl. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.AdornmentOverlay|AdornmentOverlay]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} MapTools ** | ||
| - | |||
| - | Gets an object that contains all types of map controls for configuration. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.MapTools|MapTools]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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.Note: When the map width is a percent value, the WidthInPixels 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 == | ||
| - | * Type:Double | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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.Note: When the map height is a percent value, the HeightInPixels 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 == | ||
| - | * Type:Double | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} OnClientDrawEnd ** | ||
| - | |||
| - | Gets or sets the client-side script that executes whenever a feature is drawn at the client. | ||
| - | == Remarks == | ||
| - | The OnClientDrawEnd 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} OnClientEditEnd ** | ||
| - | |||
| - | Gets or sets the client-side script that executes whenever you finish editing a shape at the client. | ||
| - | == Remarks == | ||
| - | The OnClientEditEnd 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} OnClientPopupsRequesting ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} OnClientPopupsRequested ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Popups ** | ||
| - | |||
| - | Gets a Popup collection that holds all of the popups in the map. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection<T>[[ThinkGeo.MapSuite.MvcEdition.Popup, MvcEdition, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoKeyedCollection<T>]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} RestrictedExtent ** | ||
| - | |||
| - | Gets or sets an extent that limits the area to which the map can be navigated within. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} CurrentScale ** | ||
| - | |||
| - | Gets or sets a double value that indicates the current scale of the map. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Double | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} CustomCursorUri ** | ||
| - | |||
| - | Gets and sets a custom cursor image URI for the mouse cursor to use when you select 'CursorType.Custom'. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Uri | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Id ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Width ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Unit | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Height ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Unit | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Visible ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} HtmlAttributes ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Dictionary<String,String> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ClientScriptFileNames ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Dictionary<String,String> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ClientScriptBlocks ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Dictionary<String,String> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} StyleSheetFileNames ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Collection<String> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ViewContext ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:ViewContext | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} ClientResolutions ** | ||
| - | |||
| - | Gets the resolution collection corresponding to the specified ZoomLevelSets applied to the map. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Collection<Double> | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} MaxExtent ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} PageRootPath ** | ||
| - | |||
| - | Gets a string value indicats the web page's root path for loading the default icons. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} ChY= ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.ActionBinding|ActionBinding]] | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} UniqueControlName ** | ||
| - | |||
| - | Gets current page's name. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} CenterX ** | ||
| - | |||
| - | Gets or sets a double value for center X of current viewport. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Double | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} CenterY ** | ||
| - | |||
| - | Gets or sets a double value for center Y of current viewport. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Double | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} DRY= ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} ClientScriptManager ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.MvcClientScriptManager|MvcClientScriptManager]] | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} ClientStyleSheetManager ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.MvcEdition.MvcClientStyleSheetManager|MvcClientStyleSheetManager]] | ||
| - | |||
| - | ==== Public Events ==== | ||
thinkgeo.mapsuite.mvcedition.map.1442910899.txt.gz ยท Last modified: 2015/09/22 08:34 by admin
