angular-esri-map
A collection of directives to help you use Esri maps and services in your Angular 1.x applications.
These directives can be used as-is if your mapping needs are simple, or as reference examples of the patterns that you can use to write your own directives that use the ArcGIS API for JavaScript. Read more...
Getting started
Here are a few examples showing how you can use this module to bring Esri maps into your own Angular 1.x applications.
Quick Start
To use these directives in your own Angular 1.x application, first install the module as a dependency using any of the following methods.
<script src="//npmcdn.com/angular-esri-map@2.0.0-beta.2"></script>
bower install angular-esri-map
npm install angular-esri-map
Alternatively, you can clone or download this repo and copy the desired module file (angular-esri-map.js
or angular-esri-map.min.js
) into your application.
Once you've added the module to your application, you can use the sample code below to use the scene view directive. If you have downloaded or installed locally, point to the location of the module file in your environment (instead of CDN) and load the page in a browser.
<!DOCTYPE html>
<html ng-app="esri-map-example">
<head>
<title>Angular Esri Quick Start</title>
<meta name="viewport" content="initial-scale=1.0, user-scalable=no">
<meta charset="utf-8">
<link rel="stylesheet" href="//js.arcgis.com/4.0beta3/esri/css/main.css">
</head>
<body ng-controller="MapController as vm">
<esri-scene-view map="vm.map" view-options="{scale: 50000000, center: [-101.17, 21.78]}">
</esri-scene-view>
<script src="//js.arcgis.com/4.0beta3/"></script>
<script src="//ajax.googleapis.com/ajax/libs/angularjs/1.5.0/angular.js"></script>
<script src="//npmcdn.com/angular-esri-map@2.0.0-beta.2"></script>
<script type="text/javascript">
angular.module('esri-map-example', ['esri.map'])
.controller('MapController', function(esriLoader) {
var self = this;
esriLoader.require(['esri/Map'], function(Map) {
self.map = new Map({
basemap: 'streets'
});
});
});
</script>
</body>
</html>
See the documentation for examples of how to use the other directives.
Lazy Loading of the ArcGIS API for JavaScript
If your application only shows a map under certain conditions you may want to lazy load the ArcGIS API for JavaScript. You can do this by calling the esriLoader.bootstrap()
method. See the Lazy Load Patterns page for an example of how to do this.
Development Instructions
Make sure you have Node and Gulp installed.
- Fork and clone this repo
cd
into the angular-esri-map
folder- Install the dependencies with
npm install
- run
gulp
from the command line. This will run the linting and build commands and then start a local web server hosting the application under the docs
folder - Modify the source files (under
src
) and test pages (under test
). Test pages are served along with the docs site when you run the gulp
task and are accessible from the root (i.e. http://localhost:9002/simple-map.html
). - Make a pull request to contribute your changes
Dependencies
At version 1.x, these directives and services require, at a minimum, Angular v1.3.0 and the ArcGIS API for JavaScript v3.12 (though most will work and are tested on v3.11). For version 2.x, the ArcGIS API for JavaScript v4.0 beta is required. They have been tested on every minor release of each of those libraries since then. See the compatibility table below for details.
You will need Node and Gulp to do local development.
Resources
Issues
Find a bug or want to request a new feature? Please let us know by submitting an issue. Thank you!
Contributing
Anyone and everyone is welcome to contribute. Please see our guidelines for contributing.
Licensing
Copyright 2014 Esri
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
A copy of the license is available in the repository's license.txt file.
[](Esri Tags: ArcGIS Web Mapping Angular Framework)
[](Esri Language: JavaScript)
[v2.0.0-beta.2]
Added
Added on-error
event for view directives, and site uses this to show warning in unsupported (mobile) browsers #242
Property binding patterns page #238
Added esri-webscene-slides directive and related test, example, and patterns pages #254
Added esriRegistry service and related test, example, and patterns documentation. #256
Support
Docs site is more mobile friendly #245 and shows error message when mobile browsers don't have required support for WebGL #250.
Updated quick start in README to include instructions for CDN #252.