|
| 1 | +# Getting Started with Syncfusion® Maps Component in Vue 3 |
| 2 | + |
1 | 3 | The sample demonstrates how to integrate the Syncfusion Maps component into a Vue 3 application using the Vue CLI. The following features are shown in this sample. |
2 | 4 | 1. Binding GeoJSON data source |
3 | 5 | 2. Introducing title |
4 | 6 | 3. Applying color mapping |
5 | 7 | 4. Enabling legend for the color mapped shapes |
6 | 8 | 5. Enabling data labels for the shapes |
7 | 9 | 6. Enabling tooltip for the shapes |
| 10 | + |
| 11 | +The repository contains a minimal Vue 3 app (created with Vue CLI) that registers and renders the following Syncfusion components from `@syncfusion/ej2-vue-maps`: |
| 12 | + |
| 13 | +- MapsComponent (`<ejs-maps>`) |
| 14 | + |
| 15 | +## Prerequisites |
| 16 | + |
| 17 | +[System requirements for Syncfusion® Vue UI components](https://ej2.syncfusion.com/vue/documentation/system-requirements/) |
| 18 | + |
| 19 | +## Creating Vue application using Vue CLI |
| 20 | + |
| 21 | +The easiest way to create a Vue application is to use the [`Vue CLI`](https://github.com/vuejs/vue-cli). Vue CLI versions higher than [`4.5.0`](https://v3.vuejs.org/guide/migration/introduction.html#vue-cli) are mandatory for creating applications using Vue 3. Use the following command to uninstall older versions of the Vue CLI. |
| 22 | + |
| 23 | +```bash |
| 24 | +npm uninstall vue-cli -g |
| 25 | +``` |
| 26 | + |
| 27 | +Use the following commands to install the latest version of Vue CLI. |
| 28 | + |
| 29 | +```bash |
| 30 | +npm install -g @vue/cli |
| 31 | +npm install -g @vue/cli-init |
| 32 | +``` |
| 33 | + |
| 34 | +Create a new project using the following command. |
| 35 | + |
| 36 | +```bash |
| 37 | +vue create quickstart |
| 38 | + |
| 39 | +``` |
| 40 | + |
| 41 | +Initiating a new project prompts us to select the type of project to be used for the current application. Select the option `Default (Vue 3)` from the menu. |
| 42 | + |
| 43 | + |
| 44 | +## Adding Syncfusion® Maps package in the application |
| 45 | + |
| 46 | +Use the following command to install it. |
| 47 | + |
| 48 | +```bash |
| 49 | +npm install @syncfusion/ej2-vue-maps |
| 50 | +``` |
| 51 | + |
| 52 | +## Running the application |
| 53 | + |
| 54 | +Run the application using the following command. |
| 55 | + |
| 56 | +```bash |
| 57 | +npm run serve |
| 58 | +``` |
| 59 | + |
| 60 | +Open http://localhost:8080 in your browser (Vue CLI's default dev server) to see the sample. |
| 61 | + |
0 commit comments