Skip to content
This repository has been archived by the owner on Jul 26, 2021. It is now read-only.

Repo to help you get started with the ArcGIS API for JS. It includes code autocompletion, snippets, etc. If you like it, please consider giving this repo a ⭐

License

Notifications You must be signed in to change notification settings

hhkaos/arcgis-jsapi-getting-started

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Deprecation notice: everything on this repo was moved to this one

Original code from: github.com/Esri/jsapi-resources

Getting started - ArcGIS API for JavaScript

The goal of this project is to provide the best developer experience possible for developers learning the ArcGIS API for JavaScript using VS Code properly configured to enjoy from code autocompletion and code snippets.

Table of Contents


IDE setup to speed-up your development

You will neet use Visual Studio Code to speed up your developement by using type definitions and code snippets.

  • Using ESM and type definitions (@types/arcgis-js-api) you will benefit from:
    1. Autocompletion of supported properties and methods of each class:
      Autocomplete properties example

    2. Documentation about supported parameters, links to the API Reference, etc.:
      ArcGIS type definitons example

  • Using ArcGIS API for JavaScript Snippets. It includes code snippets to:
    1. Help you instantiate classes like Webmap:
      Code snippets

    2. Providing you with all accepted values in a property like map.basemap:
      basemap-style-autocomplete-1
      basemap-style-autocomplete-2

    3. But you can also add your own code snippets

Requirements

You will need to have NodeJS, Visual Studio Code and the ArcGIS API for JavaScript Snippets previously installed.

Development

  • First time install the dependencies running: npm run install.
  • Run the development environment: npm run dev.
  • Open index.html - recomendation: use Live Server extension.
  • Edit app/main.ts and enjoy the IntelliSense & code snippets.

Documentation, videos and tutorials

To better understand the code of the index.html, app/main.ts and tsconfig.json files read this page TypeScript - Setting up your development environment.

As you can notice, you will be editing a file which uses the Typescript extension (app/main.ts), so you need to have a basic understanding on how to use TypeScript. That's why we have make this Getting started with TypeScript and ArcGIS JS API.

To get a global overview on what can be done with the API we recommend you to read the Mapping APIs and services guide and do the tutorials.

If you prefer videos, you can find all a curated playlist of videos about the JavaScript API for ArcGIS at the Esri Developer Summit 2021.

Learning paths

We are still working on selecting a curated list of resources you help you better understand which are the most important lessons to get your goal.

But if you need advise do not hesitate, open an issue.

About

Repo to help you get started with the ArcGIS API for JS. It includes code autocompletion, snippets, etc. If you like it, please consider giving this repo a ⭐

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published