Vue VectorMap Props

See Also

• Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core

The map background is a space on a map that does not contain areas. Within the background configuration object you can specify colors for the map background and its border.

When you need to display only a specific region on a map, specify the geographical coordinates of this region using the bounds option. Assign an array of four values to this option. These values represent geographical coordinates in the following format: [minLongitude, maxLatitude, maxLongitude, minLatitude] with the default range of longitude [-180, 180] and latitude [-90, 90]. See the image below to review how these values are applied to a map.

If your dataSource contains coordinates in a different range, implement a custom projection.

By default, the map in the widget is centered on the (0, 0) point. If you need to center the map on a different geographical point, assign an array of two values in the [longitude, latitude] form.

Users can use the pan control and zoom bar in the control bar panel to navigate the map.

The following code shows how to use the controlBar object to move the control bar to the right side of the map:

$(function() {
    $("#vectorMapContainer").dxVectorMap({
        // ...
        controlBar: {
            horizontalAlignment: "right"
        }
    });
});

<dx-vector-map ... >
    <dxo-control-bar
        horizontalAlignment="right">
    </dxo-control-bar>
</dx-vector-map>

// ...
import { DxVectorMapModule } from 'devextreme-angular';

@NgModule({
    imports: [
        // ...
        DxVectorMapModule
    ],
    // ...
})
export class AppModule { }

<template> 
    <DxVectorMap ... >
        <DxControlBar
            horizontal-alignment="right"
        />
    </DxVectorMap>
</template>

<script>
import { DxVectorMap, DxControlBar } from 'devextreme-vue/vector-map';

export default {
    components: {
        DxVectorMap,
        DxControlBar
    },
    // ...
}
</script>

import React from 'react';
import { VectorMap, ControlBar } from 'devextreme-react/vector-map';

class App extends React.Component {
    render() {
        return (
            <VectorMap>
                // ...
                <ControlBar
                    horizontalAlignment="right"
                />
            </VectorMap>
        );
    }
}

export default App;

@(Html.DevExtreme().VectorMap()
    @* ... *@
    .ControlBar(cb => cb
        .HorizontalAlignment(HorizontalAlignment.Right)
    )    
)

These features allow a user to export your widget into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the widget. A click on it invokes a drop-down menu that lists exporting and printing commands. The following formats are supported for exporting into: PNG, PDF, JPEG, SVG and GIF.

See Also

• exportTo(fileName, format)
• print()
• DevExpress.viz.exportWidgets(widgetInstances, options)

The vector map may contain several different layers. Each layer can be of "area", "line" or "marker" type.

The Z-order of layers depends on their order in the layers array in the following way: the first layer occupies the background, the last layer is brought to the foreground.

View Demo

A legend is a supplementary map element that helps end-users identify a map area or a map marker. The VectorMap widget can display several legends simultaneously. To configure legends, declare an array of objects and assign it to the legends option. Each object in this array specifies settings of one legend. These settings are described in this section.

Each legend requires the source option to be set. This option specifies whether it is areas or markers that must be accompanied with a legend. Learn more from the description of the source option.

A map legend contains several legend items. A legend item consists of a marker and a text. You can change the size of markers using the markerSize option. To provide texts for legend items, you need to implement the customizeText function.

View Demo

When the widget is bound to a remote data source, it can display a loading indicator while data is loading.

To enable the automatic loading indicator, set the enabled option to true.

If you want to change the loading indicator's visibility, use the show option or the showLoadingIndicator() and hideLoadingIndicator() methods.

An end-user will not be able to zoom into a map larger than the factor specified here.

View Demo

The clicked point's coordinates are available in the event field's x and y properties. The coordinates are calculated relatively to the client area which is the widget's container. To convert them into map coordinates, use the convertCoordinates(x,y) method.

See Also

• onExporting
• onFileSaving

See Also

• onExported
• onFileSaving

See Also

• onExporting
• onExported

The widget notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.

The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:

• id
  The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
• type
  The incident's type: "error" or "warning".
• args
  The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the option that was not set properly.
• text
  The text passed to the browser's console. Includes the args content, if there is any.
• widget
  The name of the widget that produced the error or warning.
• version
  The used DevExtreme version.

See Also

• Get a Widget Instance in Angular | AngularJS | Knockout | Vue | React

To identify whether the selection has been applied or canceled, call the layer element's selected() method.

View Demo

Setting this option to false disables a user to pan the map. However, you still can pan the map in code using the center(centerCoordinates) and viewport(viewportCoordinates) methods.

If you place the widget on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the widget elements may get mixed up or disappear. To solve this problem, set the pathModified option to true.

See Also

• DevExpress.viz.refreshPaths()

You can use one of the following out-of-the-box projections:

• Mercator projection
• Equirectangular projection
• Lambert cylindrical projection
• Miller cylindrical projection

To set a custom projection, implement two functions (from and to) that convert coordinates between geographical and widget coordinate systems. In addition, set the projection's aspectRatio.

Custom Projection Demo Floor Plan Demo

When this option is set to true, the widget will be redrawn automatically in case the size of its parent window changes.

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

The widget occupies its container's entire area by default. Use the size object to specify the widget's size if it should be different from that of its container. Assign 0 to size object's height and width options to hide the widget.

$(function() {
    $("#vectorMapContainer").dxVectorMap({
        // ...
        size: {
            height: 300,
            width: 600
        }
    });
});

<dx-vector-map ... >
    <dxo-size
        [height]="300"
        [width]="600">
    </dxo-size>
</dx-vector-map>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxVectorMapModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxVectorMapModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxVectorMap ... >
        <DxSize
            :height="300"
            :width="600"
        />
    </DxVectorMap>
</template>

<script>

import DxVectorMap, {
    DxSize
} from 'devextreme-vue/vector-map';

export default {
    components: {
        DxVectorMap,
        DxSize
    },
    // ...
}
</script>

import React from 'react';

import VectorMap, {
    Size
} from 'devextreme-react/vector-map';

class App extends React.Component {
    render() {
        return (
            <VectorMap ... >
                <Size
                    height={300}
                    width={600}
                />
            </VectorMap>
        );
    }
}
export default App;

Alternatively, you can style the widget's container using CSS:

$(function() {
    $("#vectorMap").dxVectorMap({
        // ...
    });
});

#vectorMap {
    width: 85%;
    height: 70%;
}

<dx-vector-map ...
    id="vectorMap">
</dx-vector-map>

#vectorMap {
    width: 85%;
    height: 70%;
}

<template>
    <DxVectorMap ...
        id="vectorMap">
    </DxVectorMap>
</template>

<script>
import DxVectorMap from 'devextreme-vue/vector-map';

export default {
    components: {
        DxVectorMap
    },
    // ...
}
</script>

<style>
#vectorMap {
    width: 85%;
    height: 70%;
}
</style>

import React from 'react';

import VectorMap from 'devextreme-react/vector-map';

class App extends React.Component {
    render() {
        return (
            <VectorMap ...
                id="vectorMap">
            </VectorMap>
        );
    }
}
export default App;

#vectorMap {
    width: 85%;
    height: 70%;
}

A theme is a widget configuration that gives the widget a distinctive appearance. Use can use one of the predefined themes or create a custom one. Changing the option values in the widget's configuration object overrides the theme's corresponding values.

Use the VizTheme enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, GenericCarmine, GenericDarkMoon, GenericSoftBlue, GenericDarkViolet, GenericGreenMist, MaterialBlueLight, MaterialLimeLight, MaterialOrangeLight, MaterialPurpleLight, MaterialTealLight.

The widget's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title option. Otherwise, set this option to an object with the text and other fields specified.

The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.

A tooltip is a miniature rectangle displaying data of an area or a marker. A tooltip appears when the end-user hovers the cursor over an area or a marker. To show tooltips, do the following.

• Enable tooltips.
  Set the enabled option to true.

• Specify text to be displayed in tooltips. Specify the customizeTooltip option.

You can also change the appearance of tooltips using fields of the tooltip configuration object.

View Demo

Assign false to this option if your map is not supposed to be viewed on touch-enabled devices.

Rolling the mouse wheel zooms a map. If you need to disable this capability, assign false to the wheelEnabled option. A user will still be able to zoom the map using the control bar.

Use this option to specify a zoom factor for a map while configuring it. This option accepts a value that is greater than 1. Note that the zooming is performed with relation to the center of the map.

Setting this option to false disables a user's ability to zoom the map. However, you can still zoom the map in code using the zoomFactor(zoomFactor) method.