Partilhar via


Usar o pacote azure-maps-control npm

O pacote azure-maps-control npm é uma biblioteca do lado do cliente que permite incorporar o controle de mapa do Azure Maps em seus aplicativos .js nó usando JavaScript ou TypeScript. Esta biblioteca facilita a utilização dos serviços REST do Azure Maps e permite-lhe personalizar mapas interativos com o seu conteúdo e imagens.

Pré-requisitos

Para usar o pacote npm em um aplicativo, você deve ter os seguintes pré-requisitos:

Instalação

Instale o pacote azure-maps-control mais recente.

npm install azure-maps-control

Este pacote inclui uma versão reduzida do código-fonte, da Folha de Estilos CSS e das definições TypeScript para o controle de mapa do Azure Maps.

Você também precisaria incorporar a folha de estilos CSS para que vários controles sejam exibidos corretamente. Se você estiver usando um empacotador JavaScript para agrupar as dependências e empacotar seu código, consulte a documentação do empacotador sobre como isso é feito. Para Webpack, é comumente feito através de uma combinação de style-loader e css-loader com a documentação disponível no style-loader.

Para começar, instale style-loader e css-loader:

npm install --save-dev style-loader css-loader

Dentro do seu ficheiro de origem, importe atlas.min.css:

import "azure-maps-control/dist/atlas.min.css";

Em seguida, adicione carregadores à parte de regras do módulo da configuração do Webpack:

module.exports = {
  module: {
    rules: [
      {
        test: /\.css$/i,
        use: ["style-loader", "css-loader"]
      }
    ]
  }
};

Consulte a seção a seguir para obter um exemplo completo.

Criar um mapa em um aplicativo .js nó

Incorpore um mapa em uma página da Web usando o pacote npm de controle de mapa.

  1. Criar um novo projeto

    npm init
    

    npm init é um comando que ajuda você a criar um arquivo package.json para seu projeto de nó. Faz-lhe algumas perguntas e gera o ficheiro com base nas suas respostas. Você também pode usar ou –yes ignorar as perguntas e usar -y os valores padrão. O arquivo package.json contém informações sobre seu projeto, como nome, versão, dependências, scripts, etc.

  2. Instale o pacote azure-maps-control mais recente.

    npm install azure-maps-control
    
  3. Instale o Webpack e outras dependências de desenvolvimento.

    npm install --save-dev webpack webpack-cli style-loader css-loader
    
  4. Atualize package.json adicionando um novo script para "build": "webpack". O arquivo agora deve ter a seguinte aparência:

    {
      "name": "azure-maps-npm-demo",
      "version": "1.0.0",
      "description": "",
      "main": "index.js",
      "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1",
        "build": "webpack"
      },
      "author": "",
      "license": "ISC",
      "dependencies": {
        "azure-maps-control": "^2.3.1"
      },
      "devDependencies": {
        "css-loader": "^6.8.1",
        "style-loader": "^3.3.3",
        "webpack": "^5.88.1",
        "webpack-cli": "^5.1.4"
      }
    }
    
  5. Crie um arquivo de configuração Webpack chamado webpack.config.js na pasta raiz do projeto. Inclua essas configurações no arquivo de configuração.

    module.exports = {
      entry: "./src/js/main.js",
      mode: "development",
      output: {
        path: `${__dirname}/dist`,
        filename: "bundle.js"
      },
      module: {
        rules: [
          {
            test: /\.css$/i,
            use: ["style-loader", "css-loader"]
          }
        ]
      }
    };
    
  6. Adicione um novo arquivo JavaScript em ./src/js/main.js com este código.

    import * as atlas from "azure-maps-control";
    import "azure-maps-control/dist/atlas.min.css";
    
    const onload = () => {
      // Initialize a map instance.
      const map = new atlas.Map("map", {
        view: "Auto",
        // Add authentication details for connecting to Azure Maps.
        authOptions: {
          authType: "subscriptionKey",
          subscriptionKey: "<Your Azure Maps Key>"
        }
      });
    };
    
    document.body.onload = onload;
    
  7. Adicione um novo arquivo HTML chamado index.html na pasta raiz do projeto com este conteúdo:

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <meta charset="utf-8" />
        <title>Azure Maps demo</title>
        <script src="./dist/bundle.js" async></script>
        <style>
          html,
          body,
          #map {
            width: 100%;
            height: 100%;
            padding: 0;
            margin: 0;
          }
        </style>
      </head>
      <body>
        <div id="map"></div>
      </body>
    </html>
    

    Seu projeto agora deve ter os seguintes arquivos:

    ├───node_modules
    ├───index.html
    ├───package-lock.json
    ├───package.json
    ├───webpack.config.js
    └───src
        └───js
            └───main.js
    
  8. Execute o seguinte comando para gerar um arquivo JavaScript em ./dist/bundle.js

    npm run build
    
  9. Abra o índice de arquivos .html em seu navegador da Web e visualize o mapa renderizado. Deve ser semelhante à seguinte imagem:

    A screenshot showing a map of the world.

Usar outros pacotes npm do Azure Maps

O Azure Maps oferece outros módulos como pacotes npm que podem ser integrados ao seu aplicativo. Estes módulos incluem:

O exemplo a seguir mostra como importar um módulo e usá-lo em seu aplicativo. Este exemplo usa azure-maps-spatial-io para ler uma cadeia de caracteres como GeoJSON e a renderiza no mapa usando uma POINT(-122.34009 47.60995) camada de bolhas.

  1. Instale o pacote do npm.

    npm install azure-maps-spatial-io
    
  2. Em seguida, use uma declaração de importação para adicionar o módulo a um arquivo de origem:

    import * as spatial from "azure-maps-spatial-io";
    
  3. Use spatial.io.ogc.WKT.read() para analisar o texto.

    import * as atlas from "azure-maps-control";
    import * as spatial from "azure-maps-spatial-io";
    import "azure-maps-control/dist/atlas.min.css";
    
    const onload = () => {
      // Initialize a map instance.
      const map = new atlas.Map("map", {
        center: [-122.34009, 47.60995],
        zoom: 12,
        view: "Auto",
        // Add authentication details for connecting to Azure Maps.
        authOptions: {
          authType: "subscriptionKey",
          subscriptionKey: "<Your Azure Maps Key>"
        }
      });
    
      // Wait until the map resources are ready.
      map.events.add("ready", () => {
        // Create a data source and add it to the map.
        const datasource = new atlas.source.DataSource();
        map.sources.add(datasource);
    
        // Create a layer to render the data
        map.layers.add(new atlas.layer.BubbleLayer(datasource));
    
        // Parse the point string.
        var point = spatial.io.ogc.WKT.read("POINT(-122.34009 47.60995)");
    
        // Add the parsed data to the data source.
        datasource.add(point);
      });
    };
    
    document.body.onload = onload;
    
  4. Webpack 5 pode lançar erros sobre não ser capaz de resolver alguns node.js módulos principais. Adicione essas configurações ao seu arquivo de configuração Webpack para corrigir o problema.

    module.exports = {
      // ...
      resolve: {
        fallback: { "crypto": false, "worker_threads": false }
      }
    };
    

Esta imagem é uma captura de tela da saída da amostra.

A screenshot showing a map of Seattle with a blue dot.

Próximos passos

Saiba como criar e interagir com um mapa:

Saiba como estilizar um mapa:

Conheça as práticas recomendadas e veja exemplos: