ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
This is an old revision of the document!
<!– Class –> Defines the fluent interface for configuring the Map control.
*System.Object
* MvcEdition [ThinkGeo.MapSuite.MvcEdition.MapBuilder * PublicKeyToken=null] Culture=neutral * Version=9.0.0.0 MvcEdition *ThinkGeo.MapSuite.MvcEdition.MvcControlBuilderBase`2[[ThinkGeo.MapSuite.MvcEdition.Map ThinkGeo.MapSuite.MvcEdition.MapBuilder
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | Map | Initializes a new instance of the MapBuilder. | |
![]() | Map, ViewContext | Initializes a new instance of the MapBuilder. |
Name | Parameters | DeclaringType | Summary |
---|
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | Overlay | Sets the active base Overlay. | |
![]() | Action<AdornmentOverlaySetting> | Configures a AdormentOverlay object in the map control. | |
![]() | Overlay | Sets an Overlay object that displays as the background map by default. | |
![]() | Action<ContextMenuSetting> | Sets the ContextMenu of the map. | |
![]() | Double, Double, Double, Double | Sets the current extent of the map. | |
![]() | Double | Sets the current scale of the map. | |
![]() | CursorType | Sets the cursor that appears when the mouse pointer is over the map control. | |
![]() | Action<OverlayCollection> | Configures the Overlays added to the map. | |
![]() | Action<LayerOverlaySetting> | Configures a LayerOverlay object that can overlap other overlays. | |
![]() | Action<EditFeatureOverlaySetting> | Configures an EditOverlay object, with which you can draw and edit shapes on client side. | |
![]() | Object | Object | |
![]() | Object | ||
![]() | Object | ||
![]() | Action<HighlightFeatureOverlaySetting> | Configures a HighlightFeatureOverlay object, which draws its features on client side and can attach the specified click event and context menu to them. | |
![]() | Dictionary<String, String> | MvcControlBuilderBase<Map,MapBuilder> | |
![]() | Boolean | Gets or sets whether the default javascript library is disabled or not. | |
![]() | BackgroundLayer | Sets the BackgroundLayer object that paints the map background. | |
![]() | Action<MapToolsSettingCollection> | Configures the MapTools in the map control. | |
![]() | GeographyUnit | Sets the GeographyUnit of the map. | |
![]() | Action<InMemoryMarkerOverlaySetting> | Configures an InMemoryMarkerOverlay object that renders markers by the specified features. | |
![]() | String | MvcControlBuilderBase<Map,MapBuilder> | |
![]() | String | Sets the ClientBaseOverlayChanged event of the map. | |
![]() | String | Sets the client click event of the map. | |
![]() | String | Sets the ClientDoubleClick event of the map. | |
![]() | String | Sets the ClientDrawEnd event of the map. | |
![]() | String | Sets the ClientEditEnd event of the map. | |
![]() | String | Sets the ClientExtentChanged event of the map. | |
![]() | String | ||
![]() | String | ||
![]() | String | Sets the OnClientTrackShapeFinished event of the map. | |
![]() | Action<PopupCollection> | Sets the popups of the map. | |
![]() | Sends the map control content to a provided HtmlTextWriter object, which wirtes the content to be rendered on the client. | ||
![]() | ResourceDeploymentMode | sets a value that indicates whether the application allows map to copy its resource images under “~/theme/default/img/”. The default value is “ResourceDeploymentMode.Automatically”, otherwise, you need to copy images to the directory. | |
![]() | RectangleShape | Sets an extent that limits the area to which the map can be navigated within. | |
![]() | Dictionary<String, String> | MvcControlBuilderBase<Map,MapBuilder> | |
![]() | Dictionary<String, String> | MvcControlBuilderBase<Map,MapBuilder> | |
![]() | Action<LayerOverlaySetting> | Configures a LayerOverlay object that displays as a background map. | |
![]() | IEnumerable<String> | MvcControlBuilderBase<Map,MapBuilder> | |
![]() | Object(overriden) | ||
![]() | WebConfigRegistrationMode | 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. | |
![]() | ZoomLevelSet | Sets the ZoomLevelSet applied to the map. |
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
![]() | Object | ||
![]() | Object |
Name | Return | DeclaringType | Summary |
---|
Name | Return | DeclaringType | Summary |
---|---|---|---|
![]() | Map | MvcControlBuilderBase<Map,MapBuilder> |
Name | Event Arguments | DeclaringType | Summary |
---|
Initializes a new instance of the MapBuilder.
Name | Type | Description |
---|---|---|
map | Map<!– ThinkGeo.MapSuite.MvcEdition.Map –> | The map control instance. |
Initializes a new instance of the MapBuilder.
Name | Type | Description |
---|---|---|
map | Map<!– ThinkGeo.MapSuite.MvcEdition.Map –> | The map control instance. |
viewContext | ViewContext<!– System.Web.Mvc.ViewContext –> | The ViewContext of the page. |
Sets the active base Overlay.
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 OverSwitcher, the currently selected overlay will be synchronized to this property after postback.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
overlay | Overlay<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> | The overlay selected from the overlay's collection. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Configures a AdormentOverlay object in the map control.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
configAdormentOverlaySettingAction | Action<AdornmentOverlaySetting><!– System.Action{ThinkGeo.MapSuite.MvcEdition.AdornmentOverlaySetting} –> | The AdormentOverlay configuration action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets an Overlay object that displays as the background map by default.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
overlay | Overlay<!– ThinkGeo.MapSuite.MvcEdition.Overlay –> | A LayerOverlay object that displays as the background map by default. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the ContextMenu of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
addContextMenuAction | Action<ContextMenuSetting><!– System.Action{ThinkGeo.MapSuite.MvcEdition.ContextMenuSetting} –> | The action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the current extent of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
minX | Double<!– System.Double –> | This property specifies the minimum X value. This is also the upper left X. |
maxY | Double<!– System.Double –> | This property specifies the maximum Y value. This is also the upper left Y. |
maxX | Double<!– System.Double –> | This property specifies the maximum X value. This is also the lower right X. |
minY | Double<!– System.Double –> | This property specifies the minimum Y value. This is also the lower right Y. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the current scale of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
scale | Double<!– System.Double –> | scale value. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the cursor that appears when the mouse pointer is over the map control.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
cursorType | CursorType<!– ThinkGeo.MapSuite.MvcEdition.CursorType –> | The type of the cursor that appears when the pointer moves over the map. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Configures the Overlays added to the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
addOverlayAction | Action<OverlayCollection><!– System.Action{ThinkGeo.MapSuite.MvcEdition.OverlayCollection} –> | CustomOverlay setting action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Configures a LayerOverlay object that can overlap other overlays.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
configOverlayAction | Action<LayerOverlaySetting><!– System.Action{ThinkGeo.MapSuite.MvcEdition.LayerOverlaySetting} –> | Overlay configuration action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Configures an EditOverlay object, with which you can draw and edit shapes on client side.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
configEditOverlayAction | Action<EditFeatureOverlaySetting><!– System.Action{ThinkGeo.MapSuite.MvcEdition.EditFeatureOverlaySetting} –> | The editOvelay configuration action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Return Type | Description |
---|---|
Boolean<!– System.Boolean –> |
Name | Type | Description |
---|---|---|
obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
Return Type | Description |
---|---|
Int32<!– System.Int32 –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Return Type | Description |
---|---|
Type<!– System.Type –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Configures a HighlightFeatureOverlay object, which draws its features on client side and can attach the specified click event and context menu to them.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
configHighlightOverlayAction | Action<HighlightFeatureOverlaySetting><!– System.Action{ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlaySetting} –> | The HighlightFeatureOverlay configuration action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
htmlAttributes | Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –> |
<!– ThinkGeo.MapSuite.MvcEdition.MvcControlBuilderBase{ThinkGeo.MapSuite.MvcEdition.Map,ThinkGeo.MapSuite.MvcEdition.MapBuilder} –> Go Back
Gets or sets whether the default javascript library is disabled or not.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
disabled | Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the BackgroundLayer object that paints the map background.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
backgroundLayer | BackgroundLayer<!– ThinkGeo.MapSuite.Core.BackgroundLayer –> | BackgroundLayer of the map. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Configures the MapTools in the map control.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
mapToolsSettingAction | Action<MapToolsSettingCollection><!– System.Action{ThinkGeo.MapSuite.MvcEdition.MapToolsSettingCollection} –> | MapTools configuration action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the GeographyUnit of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
mapUnit | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | GeographyUnit of the map. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Configures an InMemoryMarkerOverlay object that renders markers by the specified features.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
configMarkerOverlayAction | Action<InMemoryMarkerOverlaySetting><!– System.Action{ThinkGeo.MapSuite.MvcEdition.InMemoryMarkerOverlaySetting} –> | The InMemoryMarkerOverlay configuration action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
name | String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.MvcControlBuilderBase{ThinkGeo.MapSuite.MvcEdition.Map,ThinkGeo.MapSuite.MvcEdition.MapBuilder} –> Go Back
Sets the ClientBaseOverlayChanged event of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
clientBaseOverlayChanged | String<!– System.String –> | The JavaScript function name. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the client click event of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
clientClick | String<!– System.String –> | The JavaScript function name. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the ClientDoubleClick event of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
clientDoubleClick | String<!– System.String –> | The JavaScript function name. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the ClientDrawEnd event of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
clientDrawEnd | String<!– System.String –> | The JavaScript function name. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the ClientEditEnd event of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
clientEditEnd | String<!– System.String –> | The JavaScript function name. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the ClientExtentChanged event of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
clientExtentChanged | String<!– System.String –> | The JavaScript function name. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
clientPopupsRequestedEventHandler | String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
clientPopupsRequestingEventHandler | String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the OnClientTrackShapeFinished event of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
clientTrackShapeFinishedEventHandler | String<!– System.String –> | The JavaScript function name. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the popups of the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
addPopupAction | Action<PopupCollection><!– System.Action{ThinkGeo.MapSuite.MvcEdition.PopupCollection} –> | Popup setting action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sends the map control content to a provided HtmlTextWriter object, which wirtes the content to be rendered on the client.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
sets a value that indicates whether the application allows map to copy its resource images under “~/theme/default/img/”. The default value is “ResourceDeploymentMode.Automatically”, otherwise, you need to copy images to the directory.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
resourceDeploymentMode | ResourceDeploymentMode<!– ThinkGeo.MapSuite.MvcEdition.ResourceDeploymentMode –> | The depolymentMode indicates whether the control creates and releases the theme files to application folder automatically. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets an extent that limits the area to which the map can be navigated within.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
extent | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
scriptBlocks | Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –> |
<!– ThinkGeo.MapSuite.MvcEdition.MvcControlBuilderBase{ThinkGeo.MapSuite.MvcEdition.Map,ThinkGeo.MapSuite.MvcEdition.MapBuilder} –> Go Back
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
scriptFileNames | Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –> |
<!– ThinkGeo.MapSuite.MvcEdition.MvcControlBuilderBase{ThinkGeo.MapSuite.MvcEdition.Map,ThinkGeo.MapSuite.MvcEdition.MapBuilder} –> Go Back
Configures a LayerOverlay object that displays as a background map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
configOverlayAction | Action<LayerOverlaySetting><!– System.Action{ThinkGeo.MapSuite.MvcEdition.LayerOverlaySetting} –> | Overlay configuration action. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
cssFileNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.MvcEdition.MvcControlBuilderBase{ThinkGeo.MapSuite.MvcEdition.Map,ThinkGeo.MapSuite.MvcEdition.MapBuilder} –> Go Back
Return Type | Description |
---|---|
String<!– System.String –> |
Name | Type | Description |
---|
<!– System.Object(overriden) –> Go Back
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 Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
webConfigRegisterMode | WebConfigRegistrationMode<!– ThinkGeo.MapSuite.MvcEdition.WebConfigRegistrationMode –> | The register mode that indicates whether the application allows map to register the Web.config on the fly in runtime. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Sets the ZoomLevelSet applied to the map.
Return Type | Description |
---|---|
MapBuilder<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> |
Name | Type | Description |
---|---|---|
zoomLevelSet | ZoomLevelSet<!– ThinkGeo.MapSuite.Core.ZoomLevelSet –> | ZoomLevels that will be applied to map. |
<!– ThinkGeo.MapSuite.MvcEdition.MapBuilder –> Go Back
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Return Type | Description |
---|---|
Object<!– System.Object –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Return Type |
---|
Map<!– ThinkGeo.MapSuite.MvcEdition.Map –> |
<!– ThinkGeo.MapSuite.MvcEdition.MvcControlBuilderBase{ThinkGeo.MapSuite.MvcEdition.Map,ThinkGeo.MapSuite.MvcEdition.MapBuilder} –> Go Back