Class # WebMapViewer

forsearch

Maps

forsearch

Map --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description A control for viewing maps loaded via a map provider like Google. It is initially centered at the position specified by *Latitude*, *Longitude*. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |-----------------------------------------------------|----------------------------------------------------|-----------|--------| | `AllowFullScreen` | `Boolean` | | | | `APIKey` | `String` | | | | `ContextualMenu` | `WebMenuItem` | | | | `ControlID` | `String` | ✓ | | | `Enabled` | `Boolean` | | | | `HasScaleIndicator` | `Boolean` | | | | `Height` | `Integer` | | | | `Indicator` | `Indicators` | | | | `Latitude` | `Double` | | | | `Left` | `Integer` | | | | `LockBottom` | `Boolean` | | | | `LockHorizontal` | `Boolean` | | | | `LockLeft` | `Boolean` | | | | `LockRight` | `Boolean` | | | | `LockTop` | `Boolean` | | | | `LockVertical` | `Boolean` | | | | `Longitude` | `Double` | | | | `MapType` | `MapTypes` | | | | `Mode` | `Modes` | | | | `ModeData` | `String` | | | | `Name` | `String` | ✓ | | | `Page` | `WebPage` | ✓ | | | `PanelIndex` | `Integer` | | | | `Parent` | `WebView` | ✓ | | | `Renderer` | `Renderers` | | | | `RouteDrawingColor` | `ColorGroup` | | | | `RoutePenSize` | `Integer` | | | | `StyleURL` | `String` | | | | `TabIndex` | `Integer` | | | | `Tooltip` | `WebToolTip` | | | | `Top` | `Integer` | | | | `Visible` | `Boolean` | | | | `Width` | `Integer` | | | | `Zoom` | `Integer` | | | ## Methods

table-centered_column_4

| Name | Parameters | Returns | Shared | |-------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|--------| | `AcceptPictureDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AcceptRawDataDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AcceptTextDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AddLocation` | locations() As `WebMapLocation` | | | | | `ParamArray` locations() As `WebMapLocation` | | | | `AllowPictureDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AllowRawDataDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AllowTextDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `Close` | | | | | `CSSClasses` | | `WebCSSClasses` | | | `DrawRoute` | route As `MapRoute` | | | | | transportType As `MapRoute.TransportTypes` = `MapRoute.TransportTypes.Car` | | | | `ExecuteJavaScript` | script As `String` | | | | `GoToLocation` | location As `WebMapLocation`, fly As `Boolean` = `False` | | | | `GotoURL` | url As `String`, inNewWindow As `Boolean` = `False` | | | | `LastLocationIndex` | | `Integer` | | | `LocationAt` | index As `Integer` | `WebMapLocation` | | | `LocationCount` | | `Integer` | | | `RemoveAllLocations` | | | | | `RemoveLocation` | Location As `WebMapLocation` | | | | `RemoveLocationAt` | index As `Integer` | | | | `RemoveRoute` | | | | | `Route` | transportType As `MapRoute.TransportTypes` = `MapRoute.TransportTypes.Car` | `MapRoute` | | | `Search` | Query As `String` | | | | `SetFocus` | | | | | `Style` | | `WebStyle` | | | | `Assigns` style As `WebStyle` | | | | `ToPicture` | | | | | `UpdateBrowser` | | | | ## Events

table-centered_column_4

| Name | Parameters | Returns | |---------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| | `CenterChanged` | latitude As `Double`, longitude As `Double` | | | `Closed` | | | | `ContextualMenuSelected` | hitItem As `WebMenuItem` | | | `DoublePressed` | latitude As `Double`, longitude As `Double` | | | `DropObject` | obj As `WebDragItem`, action As `WebDragItem.DragActionTypes`, x As `Integer`, y As `Integer` | | | `Hidden` | | | | `LocationSelected` | location As `WebMapLocation` | | | `Opening` | | | | `Pressed` | latitude As `Double`, longitude as `Double` | | | `RequestedPicture` | map As `Picture` | | | `Shown` | | | | `ZoomChanged` | zoomLevel As `Integer` | | ## Enumerations

forsearch

WebMapViewer.MapTypes ### MapTypes > Specifies the type of map to be displayed. For example, roadmap versus satellite. > > | Enum | Description | > |-----------|---------------------------------------------------------------------------------------------| > | RoadMap | Shows roads and points of interest. This type is good for showing locations and directions. | > | Satellite | Shows satellite photos rather than roads and locations. |

forsearch

WebMapViewer.Modes ### Modes > Specifies the mode in which the map will work. For example, showing a location versus showing directions. > > | Enum | Description | > |------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| > | Place | Displays a map pin at a particular place or address, such as a landmark, business, geographic feature, or town. | > | Directions | Displays the path between two or more specified points on the map, as well as the distance and travel time. | > | Search | Displays results for a search across the visible map region. It's recommended that a location for the search be defined, either by including a location in the search term (record+stores+in+Seattle) or by including a center and zoom parameter to bound the search. | > | View | Returns a map with no markers or directions. | > | StreetView | Provides a viewer that renders the resulting panorama as a sphere with a camera at its center. You can manipulate the camera to control the zoom and the orientation of the camera. |

forsearch

WebMapViewer.Renderers ### Renderers > Specifies the map rendering provider that will render the maps. > > | Enum | Description | > |-----------------|------------------------------| > | GoogleMapsEmbed | Google's map renderer. | > | MapLibre | An open-source map renderer. | ## Property descriptions

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

WebMapViewer.AllowFullScreen **AllowFullScreen** As `Boolean` > When `True` provides a widget that allows the user to toggle between the map view consuming the designated space on the page versus consuming the entire browser window.

forsearch

WebMapViewer.APIKey **APIKey** As `String` > Specifies the APIKey to use with Google Maps. > > Google Maps requires an API Key. Visit the [Google Maps API Key page](https://developers.google.com/maps/documentation/javascript/get-api-key) to get your own API Key. > > Always set your API key, usually in the Opening event: > > ``` xojo > Me.APIKey = "" > ```

forsearch

WebMapViewer.ContextualMenu **ContextualMenu** As `WebMenuItem` > If you assign a `WebMenuItem` to the control, it will be displayed when the user right-clicks the control. > > On a `WebPage`, you can disable/remove the default contextual menu by an empty `WebMenuItem` class object to this property. > > This code populates a contextual menu in the Shown event of the control. > > ``` xojo > Var menu As New WebMenuItem > > menu.AddMenuItem("One") > menu.AddMenuItem("Two") > menu.AddMenuItem("Three") > Me.ContextualMenu = menu > ``` > > The menu selection is then handled by the ContextualMenuSelected event when the user right-clicks on the control. For example, it can be of the form: > > ``` xojo > Select Case hitItem.Text > Case "One" > MessageBox("One") > Case "Two" > MessageBox("Two") > Case "Three" > MessageBox("Three") > End Select > ```

forsearch

WebMapViewer.ControlID **ControlID** As `String` > Identifies the control on a per session basis. > > This property is read-only.

forsearch

WebMapViewer.Enabled **Enabled** As `Boolean` > When `True` the **WebControl** is drawn enabled and responds to user action. When `False`, the control appears as disabled and does not respond to user actions. > > In the case of `WebTimer`, when set to `False` this disables and stops the WebTimer. When set to `True`, it starts the WebTimer. > > Disable a button when a check box value changes: > > ``` xojo > If AllowSaveCheckBox.Value Then > SaveButton.Enabled = True > Else > AllowSaveButton.Enabled = False > End If > ```

forsearch

WebMapViewer.HasScaleIndicator **HasScaleIndicator** As `Boolean` > Allows to show or hide a visual element with the scale representation.

forsearch

WebMapViewer.Height **Height** As `Integer` > The height (in pixels) of the control.

forsearch

WebMapViewer.Indicator **Indicator** As `Indicators` > The color scheme for the control.

forsearch

WebMapViewer.Latitude **Latitude** As `Double` > Sets or Gets the latitude of the center of the map being displayed. Because you would normally want to set both the latitude and longitude, you must also call the `UpdateBrowser` method to send the changes to the browser. > > Set the map to a specific latitude and longitude: > > ``` xojo > MapViewer1.Latitude = 38.8977 > MapViewer1.Longitude = -77.0366 > MapViewer1.Update > ```

forsearch

WebMapViewer.Left **Left** As `Integer` > The position of the left side of the **WebUIControl** in pixels, relative to the web page.

forsearch

WebMapViewer.LockBottom **LockBottom** As `Boolean` > Determines whether the bottom edge of the control should stay at a set distance from the bottom edge of the parent control, if there is one, or the owning web page.

forsearch

WebMapViewer.LockHorizontal **LockHorizontal** As `Boolean` > LockHorizontal overrides LockLeft and LockRight. It allows you to proportionally lock a control's position to the center of its parent control (or web page). > > For example, if you place a control in the center of the page and sets both LockHorizontal and LockVertical, the control will stay in the center of the page.

forsearch

WebMapViewer.LockLeft **LockLeft** As `Boolean` > Determines whether the left edge of the control should stay at a set distance from the left edge of the parent control, if there is one, or the owning web page.

forsearch

WebMapViewer.LockRight **LockRight** As `Boolean` > Determines whether the right edge of the control should stay at a set distance from the right edge of the parent control, if there is one, or the owning web page.

forsearch

WebMapViewer.LockTop **LockTop** As `Boolean` > Determines whether the top edge of the control should stay at a set distance from the top edge of the parent control, if there is one, or the owning web page.

forsearch

WebMapViewer.LockVertical **LockVertical** As `Boolean` > LockVertical overrides LockTop and LockBottom. It allows you to proportionally lock a control's position to keep it centered within the parent control or web page. > > For example, if you place a control in the center of the page, and sets both LockHorizontal and LockVertical, the control will stay in the center of the page.

forsearch

WebMapViewer.Longitude **Longitude** As `Double` > Sets or Gets the longitude of the center of the map being displayed. Because you would normally want to set both the latitude and longitude, you must also call the `UpdateBrowser` method to send the changes to the browser. > > Set the map to a specific latitude and longitude: > > ``` xojo > MapViewer1.Latitude = 38.8977 > MapViewer1.Longitude = -77.0366 > MapViewer1.Update > ```

forsearch

WebMapViewer.MapType **MapType** As `MapTypes` > Sets or gets the type of map being displayed. > > Change the map type to a road map: > > ``` xojo > Me.MapType = WebMapViewer.MapTypes.RoadMap > ```

forsearch

WebMapViewer.Mode **Mode** As `Modes` > Sets or gets the mode of the map being displayed. > > Change the map type to street view: > > ``` xojo > Me.Mode = WebMapViewer.Modes.StreetView > ```

forsearch

WebMapViewer.ModeData **ModeData** As `String` > The data required for the `Mode` when it's set to Place or Search.

forsearch

WebMapViewer.Name **Name** As `String` > The name of the control. > > This property is read-only.

forsearch

WebMapViewer.Page **Page** As `WebPage` > Identifies the web page that contains the control. > > This property is read-only.

forsearch

WebMapViewer.PanelIndex **PanelIndex** As `Integer` > If the control has been placed on a WebTabPanel or `WebPagePanel` control, this is the panel (page/tab) that the control is on. If the control is not on a panel, it returns -1. > > The first panel is numbered zero. If the control has been placed on a panel of a WebTabPanel or `WebPagePanel` control, it returns the panel number. If the control is not on a `WebPagePanel` or WebTabPanel, it returns -1. If you change the PanelIndex to a nonexistent panel, the control will disappear until you give it a PanelIndex value that corresponds to a panel that exists. > > If you are looking to change the currently selected panel (page/tab), use `SelectedPanelIndex`. > > This code displays the panel index of the control that is on the page. > > ``` xojo > MessageBox(Me.SelectedPanelIndex.ToString) > ```

forsearch

WebMapViewer.Parent **Parent** As `WebView` > Used to get the control's parent control or page. If the parent control is a `WebContainer`, then it returns the `WebContainer`. If it is on a `WebPage`, it returns the `WebPage`. > > This property is read-only.

forsearch

WebMapViewer.Renderer **Renderer** As `Renderers` > Indicates which map service provider will be used to render the map.

forsearch

WebMapViewer.RouteDrawingColor **RouteDrawingColor** As `ColorGroup` > The color of the route on the map.

forsearch

WebMapViewer.RoutePenSize **RoutePenSize** As `Integer` > The thickness of the line that indicates the route on the map.

forsearch

WebMapViewer.StyleURL **StyleURL** As `String` > Returns a URL from the map providing pointing to the location of a style file. > > Style files are JSON documents that follow the [MapLibre Style Spec](https://maplibre.org/maplibre-style-spec/). > > The easiest way to create a customized map is to register in one of the providers that supports this format. These providers will give you a style URL that you can use with your map: > > - > - > - > - > > By default, Xojo uses [OpenStreetMap](https://www.openstreetmap.org/) raster tiles which should be OK for development or small web applications. > > You are not limited to using third party providers anymore. In projects where privacy is important or when you don not want to be worried about monthly limits or prices, you can use software installed on premises to serve your own map vector tiles. > > [Martin](https://github.com/maplibre/martin) is Open Source, but you can also use a commercial solution like [MapTiler Server](https://www.maptiler.com/server/).

forsearch

WebMapViewer.TabIndex **TabIndex** As `Integer` > The **WebMapViewer's** control's position in the Tab Order. The control with a TabIndex of 0 is the first **WebUIControl** to get the focus when the page opens in the browser. > > This example sets the control's TabIndex. > > ``` xojo > Me.TabIndex = 2 > ```

forsearch

WebMapViewer.Tooltip **Tooltip** As `WebToolTip` > Text of a message displayed as a tooltip. > > The tip is displayed when the user places the mouse on the control and leaves it there. > > This code in the Shown event of a Button sets the tooltip: > > ``` xojo > Me.Tooltip = "Save changes" > ```

forsearch

WebMapViewer.Top **Top** As `Integer` > The top of the control in local coordinates relative to the web page.

forsearch

WebMapViewer.Visible **Visible** As `Boolean` > If `True`, the control is drawn. If `False`, it's not. > > Hide a control based on a checkbox setting: > > ``` xojo > If ShowEmailCheckbox.Value Then > EmailField.Visible = True > Else > EmailField.Visible = False > End If > ```

forsearch

WebMapViewer.Width **Width** As `Integer` > The width (in pixels) of the web control. > > This code in the Shown event handler increases the size of the control: > > ``` xojo > Me.Width = Me.Width + 50 > ```

forsearch

WebMapViewer.Zoom **Zoom** As `Integer` > Sets or gets the zoom level of the map being displayed. > > Typically the Zoom is a value from 1 (minimum zoom) to 20 (maximum zoom). > > Zoom in the current map location to the maximum zoom, which is typically street-level: > > ``` xojo > Me.Zoom = 20 > ``` ## Method descriptions

forsearch

WebMapViewer.AcceptPictureDrop **AcceptPictureDrop**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to accept a picture drop of a `WebDragItem`.

forsearch

WebMapViewer.AcceptRawDataDrop **AcceptRawDataDrop**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to accept a raw data drop of a `WebDragItem`.

forsearch

WebMapViewer.AcceptTextDrop **AcceptTextDrop**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to accept a picture drop of a `WebDragItem`.

forsearch

WebMapViewer.AddLocation **AddLocation**(locations() As `WebMapLocation`) > Adds the array of `location` objects to the map, indicated by pins. > > Add a location to the map: > > ``` xojo > Var location As New WebMapLocation("Fenway Park, Boston, MA") > MapViewer1.AddLocation(location) > ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **AddLocation**(`ParamArray` locations() As `WebMapLocation`) > Adds the `location` objects to the map, indicated by pins. > > Add the Grand Canyon and the White House locations to MapViewer1: > > ``` xojo > Var grandCanyon As New WebMapLocation(36.056595, -112.125092) > Var whiteHouse As New WebMapLocation(38.897957, -77.036560) > > MapViewer1.AddLocation(grandCanyon, whiteHouse) > ```

forsearch

WebMapViewer.AllowPictureDrag **AllowPictureDrag**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to be dragged as a picture.

forsearch

WebMapViewer.AllowRawDataDrag **AllowRawDataDrag**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to be dragged as raw data.

forsearch

WebMapViewer.AllowTextDrag **AllowTextDrag**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to be dragged as text.

forsearch

WebMapViewer.Close **Close** > Removes the control from the page.

forsearch

WebMapViewer.CSSClasses **CSSClasses** > Returns the instance of `WebCSSClasses` for this control allowing you to add CSS classes to and remove CSS classes from the control.

forsearch

WebMapViewer.DrawRoute **DrawRoute**(route As `MapRoute`) > Draws the route on the map. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **DrawRoute**(transportType As `MapRoute.TransportTypes` = `MapRoute.TransportTypes.Car`) > Draws the route based upon locations that have been added with `AddLocation`.

forsearch

WebMapViewer.ExecuteJavaScript **ExecuteJavaScript**(script As `String`) > Executes the JavaScript passed. The JavaScript passed can call a JavaScript function in a WebPageSource control. > > The Xojo web framework uses EcmaScript 6 which is more strict than previous versions of JavaScript. For more details, see the [EcmaScript 6 documentation](https://www.ecma-international.org/ecma-262/6.0/). > > This code in the Pressed event of a Button displays an alert using JavaScript: > > ``` xojo > Me.ExecuteJavaScript("alert('Hello!');") > ``` > > This code will select the text in a WebTextField (or WebTextArea): > > ``` xojo > WebTextField1.ExecuteJavascript("document.getElementById('" + _ > WebTextField1.ControlID + "_inner').select();") > ```

forsearch

WebMapViewer.Route **Route**(transportType As `MapRoute.TransportTypes` = `MapRoute.TransportTypes.Car`) > Returns a `route` based upon the locations added with `AddLocation`.

forsearch

WebMapViewer.GoToLocation **GoToLocation**(location As `WebMapLocation`, fly As `Boolean` = `False`) > Centers the map on the passed `WebMapLocation`. > > Centers the map on the specific location: > > ``` xojo > Var location As New WebMapLocation("Fenway Park, Boston, MA") > MapViewer1.GoToLocation(location) > ```

forsearch

WebMapViewer.GotoURL **GotoURL**(url As `String`, inNewWindow As `Boolean` = `False`) > Opens the passed *url* in place of the current web page or downloads a file. If *inNewWindow* is `True`, the browser is asked to open the *url* in a new window. > > If the browser has popup windows disabled and *inNewWindow* is `True`, the method silently fails and the page is not shown. > > If *inNewWindow* is `False`, the running web app is replaced with the specified *url*. If you want to display an external web site within your web app, use the `WebHTMLViewer` control. > > Display a web site in a new popup window: > > ``` xojo > Me.GotoURL("http://www.wikipedia.org", True) > ```

forsearch

WebMapViewer.LastLocationIndex **LastLocationIndex** As `Integer` > The index of the last location.

forsearch

WebMapViewer.LocationAt **LocationAt**(index As `Integer`) As `WebMapLocation` > The `map location` at the *index* passed.

forsearch

WebMapViewer.LocationCount **LocationCount** As `Integer` > The number of locations on the map that were added with the `AddLocation` method.

forsearch

WebMapViewer.RemoveAllLocations **RemoveAllLocations** > Removes all locations from the map that were added with the `AddLocation` method.

forsearch

WebMapViewer.RemoveLocation **RemoveLocation**(Location As `WebMapLocation`) > Removes a `WebMapLocation` object from the map. If the location is visible on the map, the icon is also removed. > > If Location is a property of the web page for a location that has been previously added, you can remove it: > > ``` xojo > If Location Is Not Nil Then > MapViewer1.RemoveLocation(location) > End If > ```

forsearch

WebMapViewer.RemoveLocationAt **RemoveLocationAt**(index As `Integer`) > Removes the location (added with the `AddLocation` method) at the *index* passed from the map.

forsearch

WebMapViewer.RemoveRoute **RemoveRoute** > Removes the route from the map.

forsearch

WebMapViewer.Search **Search**(Query As `String`) > Performs a maps query based upon the query passed.

forsearch

WebMapViewer.SetFocus **SetFocus** > Sets the focus to the `Control`. > > This code checks for a required value when a button is pressed: > > ``` xojo > If UserNameField.Text.IsEmpty Then > MessageBox("Please enter your UserName.") > UserNameField.SetFocus > Return > End If > ```

forsearch

WebMapViewer.Style **Style** As `WebStyle` > Returns the `WebStyle` for the control. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **Style**(`Assigns` style As `WebStyle`) > Assigns the *style* to the control. > > In this example, in any event of the control, set the text to bold: > > ``` xojo > Var style As New WebStyle > style.Bold = True > Me.Style = style > ```

forsearch

WebMapViewer.ToPicture **ToPicture** > Creates a `Picture` from the map. The `Picture` is returned via the `RequestedPicture` event.

forsearch

WebMapViewer.UpdateBrowser **UpdateBrowser** > Forces the current values of the control to be sent to the browser. > > This method is useful when you are computing values in a loop and wish to update the browser immediately rather than wait until the current method ends. > > This code iterates through a `RowSet` of `database rows`, updates a `ProgressBar` and then forces the updated `ProgressBar` to be sent to the browser via UpdateBrowser. > > ``` xojo > ProgressBar1.MaximumValue = SalesData.RowCount > > For Each row As DatabaseRow in SalesData > AnalyzeSales(row) > ProgressBar1.Value = ProgressBar1.Value + 1 > ProgressBar1.UpdateBrowser > Next > ``` ## Event descriptions

forsearch

WebMapViewer.CenterChanged **CenterChanged**(latitude As `Double`, longitude As `Double`) > The map has been recentered.

forsearch

WebMapViewer.Closed **Closed** > The control has been removed from the browser either because the page has closed or the control's Close method was called.

forsearch

WebMapViewer.ContextualMenuSelected **ContextualMenuSelected**(hitItem As `WebMenuItem`) > Called when a contextual menu item is selected. This selected item is contained in *hitItem*. > > This code populates a contextual menu in the Opening event of a `WebToolbar`: > > ``` xojo > Var menu As New WebMenuItem > > menu.AddMenuItem("One") > menu.AddMenuItem("Two") > menu.AddMenuItem("Three") > Me.ContextualMenu = menu > ``` > > The menu selection is then handled by the ContextualMenuSelected event when the user right-clicks on the control. For example, it can be of the form: > > ``` xojo > Select Case hitItem.Text > Case "One" > MessageBox("One") > Case "Two" > MessageBox("Two") > Case "Three" > MessageBox("Three") > End Select > ```

forsearch

WebMapViewer.DoublePressed **DoublePressed**(latitude As `Double`, longitude As `Double`) > The user double-clicked or double-tapped a location on the map.

forsearch

WebMapViewer.DropObject **DropObject**(obj As `WebDragItem`, action As `WebDragItem.DragActionTypes`, x As `Integer`, y As `Integer`) > Called when a dragged item is over a control that can accept it. The dragged item is contained in *obj* and the type of drag is identified by *action*.

forsearch

WebMapViewer.Hidden **Hidden** > The control is about to become no longer visible. This could be because the page is being closed, is being replaced as the foreground page by another page or because the control or a parent control's Visible property has been set to `False`. > >

> >

> > Note > >

> > This event is equivalent to the `DesktopWindow.Deactivated` event in a desktop app. > >

forsearch

WebMapViewer.LocationSelected **LocationSelected**(location As `WebMapLocation`) > The *location* passed has been selected by the user.

forsearch

WebMapViewer.Opening **Opening** > The control has been created and the page is opening but has not been sent to the browser yet. > > The Opening event handler can be used to initialize non-visual properties and settings for controls. > > In most cases, you should use the `Shown` event to initialize controls.

forsearch

WebMapViewer.Pressed **Pressed**(latitude As `Double`, longitude as `Double`) > A location on the map at the *latitude* and *longitude* passed as been tapped or clicked.

forsearch

WebMapViewer.RequestedPicture **RequestedPicture**(map As `Picture`) > This event is called when `ToPicture` method is called. The event will come with a `Picture` representing the map.

forsearch

WebMapViewer.Shown **Shown** > The control has appeared on the currently displayed page. This could be because its parent page just finished loading, its parent page has come to the foreground or the control is now visible having been previously invisible because it or its parent control's Visible property has been set to `True`. > > Use the Shown event for initializing your controls or doing anything that would interact with other controls or user interface elements on the web page instead of the `Opening` event. > >

> >

> > Note > >

> > This event is the web equivalent to the `DesktopWindow.Activated` event. > >

> > This code in the Shown event of a `WebListBox` adds 2 rows with 3 columns: > > ``` xojo > Me.RemoveAllRows > Me.AddRow("Row 1", "Bob", "Roberts") > Me.AddRow("Row 2", "Barb", "Reynolds") > ``` > > This example sets the text of a label: > > ``` xojo > If Session.LoggedIn Then > Me.Text = "Welcome!" > Else > Me.Text = "Welcome, " + Session.UserName > End If > ```

forsearch

WebMapViewer.ZoomChanged **ZoomChanged**(zoomLevel As `Integer`) > The level of map magnification (zoom) has changed. ## Notes

Warning

As of June 2018, Google Maps requires an API Key. You will need to set the `APIKey property` to your API Key in order for WebMapViewer to display any maps.

The WebMapViewer control is based on Google maps. As such, has the same strengths and limitations of Google Maps. If errors occur during initialization of the WebMapViewer and you are running in debug mode, the error messages will appear in the IDE Messages pane. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### Google maps api key As of June 2018, Google Maps requires an API Key. Visit the Google Maps docs for more information on usage: [Google Maps Platform User Guide](https://cloud.google.com/maps-platform/user-guide/) --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### The mapviewer user interface When you add a WebMapViewer control to a `WebPage`, it comes with widgets to manipulate the zoom, the type, and the location. The zoom level is adjusted via the Slider control on the left and you can change the location by dragging with the hand (top-left). The type of map is changed by clicking the segmented control on the top-right corner. When you change the type (for example, from Map to Satellite), a check box appears below the Segmented Control to toggle that view type. If Map is selected, a Terrain checkbox appears to show or hide terrain features; if Satellite is selected, a checkbox appears to show or hide labels. ## Sample code Create and display a location on the map: ``` xojo Var location As New WebMapLocation("Fenway Park, Boston, MA") MapViewer1.GoToLocation(location) ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Display a location entered by the user (in the LocationField TextField) on the map: ``` xojo MapViewer1.Search(LocationField.Text) ``` ## Compatibility | | | |-----------------------|-----| | **Project Types** | Web | | **Operating Systems** | All |

`WebUIControl` parent class; `WebMapLocation` class.