Bing Maps in React Maps component

06 Oct 2022 / 5 minutes to read

Bing Maps is a online Maps provider, owned by Microsoft. As like OSM, it provide Maps tile images based on our requests and combines those images into a single one to display Maps area.

Adding Bing Maps

The Bing Maps can be rendered using the urlTemplate property, which is based on the URL generated by the getBingUrlTemplate method in the Maps. The format of the required URL of Bing Maps varies from other online map providers. As a result, a built-in getBingUrlTemplate method has been included that returns the URL in a generic format. In the meantime, a subscription key is required for Bing Maps. The Bing Maps key can be obtained from here, then append it to the Bing Maps URL before passing it to the getBingUrlTemplate method. The URL returned by this method must be passed to the urlTemplate property.

import * as React from "react";
import * as ReactDOM from "react-dom";
import { MapsComponent, LayersDirective, LayerDirective } from '@syncfusion/ej2-react-maps';

load(args) {
    args.maps.getBingUrlTemplate("https://dev.virtualearth.net/REST/V1/Imagery/Metadata/Aerial?output=json&uriScheme=https&key=?").then(function(url) {
        args.maps.layers[0].urlTemplate= url;
    });
}
ReactDOM.render(
            <MapsComponent id="maps" load={this.load.bind(this)}>
                <LayersDirective>
                    <LayerDirective />
                </LayersDirective>
            </MapsComponent>,
document.getElementById("maps") as HTMLElement
);

Types of Bing Maps

Bing Maps provides different types of Maps and it is supported in the Maps component.

Aerial - Displays satellite images to highlight roads and major landmarks for easy identification.
AerialWithLabel - Displays aerial Maps with labels for the continent, country, ocean, etc.
Road - Displays the default Maps view of roads, buildings, and geography.
CanvasDark - Displays dark version of the road Maps.
CanvasLight - Displays light version of the road Maps.
CanvasGray - Displays grayscale version of the road Maps.

To render the light version of the road Maps, set the CanvasLight value is passed via the URL into the getBingUrlTemplate method demonstrated in the following code sample.

import * as React from "react";
import * as ReactDOM from "react-dom";
import { MapsComponent, LayersDirective, LayerDirective, Zoom, Inject } from '@syncfusion/ej2-react-maps';

load(args) {
args.maps.getBingUrlTemplate("https://dev.virtualearth.net/REST/V1/Imagery/Metadata/CanvasLight?output=json&uriScheme=https&key=?").then(function(url) {
    args.maps.layers[0].urlTemplate= url;
});
}

ReactDOM.render(
        <MapsComponent id="maps" zoomSettings= {{ zoomFactor: 4 }}
                                centerPosition = {{
                                    latitude : 38.8951,
                                    longitude : -77.0364
                                }} load={this.load.bind(this)}>
            <Inject services={[Zoom]} />
            <LayersDirective>
                <LayerDirective />
            </LayersDirective>
        </MapsComponent>,
document.getElementById("maps") as HTMLElement
);

Enabling zooming and panning

Bing Maps layer can be zoomed and panned. Zooming helps to get a closer look at a particular area on a Maps for in-depth analysis. Panning helps to move a Maps around to focus the targeted area.

import * as React from "react";
import * as ReactDOM from "react-dom";
import { MapsComponent, LayersDirective, LayerDirective, Zoom, Inject } from '@syncfusion/ej2-react-maps';

load(args) {
args.maps.getBingUrlTemplate("https://dev.virtualearth.net/REST/V1/Imagery/Metadata/Aerial?output=json&uriScheme=https&key=?").then(function(url) {
    args.maps.layers[0].urlTemplate= url;
});
}

ReactDOM.render(
        <MapsComponent id="maps" load={this.load.bind(this)} zoomSettings= {{
                                    enable : true,
                                    toolbars:[ "Zoom", "ZoomIn", "ZoomOut", "Pan", "Reset" ]}}>
            <Inject services={[Zoom]} />
            <LayersDirective>
                <LayerDirective />
            </LayersDirective>
        </MapsComponent>,
document.getElementById("maps") as HTMLElement
);

Markers can be added to the layers of Bing Maps by setting the corresponding location’s coordinates of latitude and longitude using markerSettings. Navigation lines can be added on top of an Bing Maps layer for highlighting a path among various places by setting the corresponding location’s coordinates of latitude and longitude in the navigationLineSettings.

import * as React from "react";
import * as ReactDOM from "react-dom";
import { MapsComponent, MarkersDirective, NavigationLineDirective, NavigationLinesDirective, MarkerDirective, LayersDirective, LayerDirective, Inject, Zoom, Marker, NavigationLine } from '@syncfusion/ej2-react-maps';

load(args) {
args.maps.getBingUrlTemplate("https://dev.virtualearth.net/REST/V1/Imagery/Metadata/Aerial?output=json&uriScheme=https&key=?").then(function(url) {
    args.maps.layers[0].urlTemplate= url;
});
}

ReactDOM.render(
        <MapsComponent id="maps" load={this.load.bind(this)} zoomSettings= {{
                                    zoomFactor : 4
                                    }}
                                    centerPosition = {{
                                        latitude: 29.394708,
                                        longitude: -94.954653
                                    }}>
        <Inject services={[Zoom, Marker, NavigationLine]} />
            <LayersDirective>
                <LayerDirective>
                    <MarkersDirective>
                        <MarkerDirective visible={true}
                                        height={25}
                                        width={15}
                                        dataSource={[
                                            {
                                                latitude: 34.060620,
                                                longitude: -118.330491,
                                                name: "California"
                                            },
                                            {
                                                latitude: 40.724546,
                                                longitude: -73.850344,
                                                name: "New York"
                                            }
                                        ]}
                                    >
                        </MarkerDirective>
                    </MarkersDirective>
                    <NavigationLinesDirective>
                        <NavigationLineDirective visible={true}
                                                 latitude={[34.060620, 40.724546]}
                                                 longitude={[-118.330491,-73.850344]}
                                                 color="blue"
                                                 angle={90}
                                                 width={5} />
                    </NavigationLinesDirective>
                </LayerDirective>
            </LayersDirective>
        </MapsComponent>,
document.getElementById("maps") as HTMLElement
);

Adding sublayer

Any GeoJSON shape can be rendered as a sublayer on top of the Bing Maps layer for highlighting a particular continent or country in Bing Maps by adding another layer and specifying the type property of Maps layer to SubLayer.

import { africa } from 'africa_continent.ts';
import * as React from "react";
import * as ReactDOM from "react-dom";
import { MapsComponent, LayersDirective, LayerDirective } from '@syncfusion/ej2-react-maps';

load(args) {
args.maps.getBingUrlTemplate("https://dev.virtualearth.net/REST/V1/Imagery/Metadata/Aerial?output=json&uriScheme=https&key=?").then(function(url) {
    args.maps.layers[0].urlTemplate= url;
});
}

ReactDOM.render(
        <MapsComponent load={this.load.bind(this)} id="maps">
            <LayersDirective>
                <LayerDirective/>
                <LayerDirective shapeData= {africa_continent}
                                type= 'SubLayer'
                                shapeSettings= {{
                                    fill: 'blue'
                                }}

                />
            </LayersDirective>
        </MapsComponent>,
document.getElementById("maps") as HTMLElement
);

Enabling legend

The legend can be added to the tile Maps by setting the visible property of legendSettings to true.

import { markerDataSource } from 'markerdata.ts';
import * as React from "react";
import * as ReactDOM from "react-dom";
import { MapsComponent, LayersDirective, LayerDirective, Marker, MarkersDirective, MarkerDirective, Legend, Inject } from '@syncfusion/ej2-react-maps';

load(args) {
args.maps.getBingUrlTemplate("https://dev.virtualearth.net/REST/V1/Imagery/Metadata/Aerial?output=json&uriScheme=https&key=?").then(function(url) {
    args.maps.layers[0].urlTemplate= url;
});
}

ReactDOM.render(
        <MapsComponent
          id="maps"
          load={this.load.bind(this)}
          ref={(m) => (this.mapInstance = m)}
          legendSettings={{
            visible: true,
            type: 'Markers',
            useMarkerShape: true,
            toggleLegendSettings: {
              enable: true,
              applyShapeSettings: false,
              border: {
                color: 'green',
                width: 2,
              },
            },
          }}
        >
          <Inject services={[Marker, Legend]} />
          <LayersDirective>
            <LayerDirective>
              <MarkersDirective>
                <MarkerDirective
                  visible={true}
                  dataSource={markerDataSource}
                  colorValuePath="color"
                  shapeValuePath="shape"
                  legendText="country"
                ></MarkerDirective>
              </MarkersDirective>
            </LayerDirective>
          </LayersDirective>
        </MapsComponent>,
document.getElementById("maps") as HTMLElement
);

Contents

Adding Bing Maps
Types of Bing Maps
Enabling zooming and panning
Adding markers and navigation line
Adding sublayer
Enabling legend