arcgis-jsapi-snippets README

NOTE: This extension is deprecated. Use the ArcGIS Maps SDK for JavaScript extension instead.

Collection of VSCode snippets for common code patterns with ArcGIS API for JavaScript and a VSCode extension (in the extension folder) that you can view in VSCode marketplace.

How to use it

To install this extension you need to have VSCode version 1.35 or higher.

After installing type in the prefix for the code snippet followed by the Tab key:

Another option for working with snippets is to install the Snippet Viewer Visual Studio Code extension. This extension adds a new option to the activity bar that lets you quickly browse and insert built-in and custom snippts.

example

make sure to have "editor.tabCompletion": "on" in the settings (Preferences > Open Settings(JSON))
if pressing Tab doesn't work then you might have several snippets with the same prefix. Press Ctrl-Space (Cmd-Space on mac) to select the one you need.

Read more about this feature in the official VSCode documentation.

Features

HTML snippets

Prefix	Description
getApi	Add the css and javascript for the Esri ArcGIS API for JavaScript from the CDN. This snippet also stubs out the package paths.
calcite	Add the css and javascript for the Esri Calcite Design System from the CDN.

JavaScript snippets

Prefix	Description
require	Load the Map and MapView modules using require
map	Create a map and view. Contains placeholders for the basemap, container, zoom and center
scene	Create a scene and view. Contains placeholders to replace the basemap and the container value.
webmap	Create a map from a WebMap. Contains a placeholder for the portal item id and for the container.
webscene	Create a 3D map from a WebScene. Contains a placeholder for the portal item id and for the container.
addLayerFromPortalItem	Add a new layer to the map using a portal item id. Contains a placeholder for the portal item id.
simpleRenderer	Generate a simple renderer. Contains a placeholder for the symbol.
uniqueValueRenderer	Generate a unique value renderer. Contains a placeholder for the field, the symbol and it generates a uniqueValueInfos array with placeholers for value, symbol and label for the legend.
classBreaksRenderer	Generate a class breaks renderer. Contains a placeholder for the field, the default symbol and it generates a classBreakInfos array with placeholers for minValue, maxValue, symbol and label for the legend.
sizeVar	Creates a SizeVariable with 2 size stops. The axis property is only used in 3D. It contains placeholders for field, normalizationField, the legend title and the size stop values.
colorVar	Creates a ColorVariable with 2 color stops. It contains placeholders for field, normalizationField, the legend title and the color stop values.
clusterConfig	Generates the configuration for clustering in a MapView. This should be set on layers containing point geometry.
labeling2d	Creates the labelingInfo for labels in a MapView.
labeling3d	Creates the labelingInfo for labels in a SceneView.
simpleMarkerSymbol	Creates a SimpleMarkerSymbol in a MapView. Contains placeholder for style.
pictureMarkerSymbol	Creates a PictureMarkerSymbol in a MapView.
simpleLineSymbol	Creates a SimpleLineSymbol in a MapView. Contains placeholder for style, cap and join.
simpleFillSymbol	Creates a SimpleFillSymbol in a MapView. Contains placeholder for style.
pictureFillSymbol	Creates a PictureFillSymbol in a MapView.
icon	Creates a PointSymbol3D with IconSymbol3DLayer in a SceneView. Contains placeholders for primitive, color and size..
line	Creates a LineSymbol3D with a LineSymbol3DLayer in a SceneView. Contains placeholders for color and size.
path	Creates a LineSymbol3D with a PathSymbol3DLayer in a SceneView. Contains placeholders for profile, color, width, height, join, cap, anchor and profileRotation.
fill	Creates a PolygonSymbol3D with a FillSymbol3DLayer in a SceneView. Contains placeholders for style, material color and outline color.
water	Creates a PolygonSymbol3D with a WaterSymbol3DLayer in a SceneView. Contains placeholder for waterbodySize and waveStrength.
extrude	Creates a PolygonSymbol3D with an ExtrudeSymbol3DLayer in a SceneView. Contains placeholders for material color and size.
mesh	Creates a MeshSymbol3D with a FillSymbol3DLayer in a SceneView. Contains placeholder for color.
edges	Creates an edges object that can be applied to a FillSymbol3DLayer. Contains placeholders for the type of edges (solid or sketch), the color, the size and the extensionLength.
calloutSmall	Generates the verticalOffset for a city scale level and the callout property. They should be set on PointSymbol3D or LabelSymbol3D. Contains placeholders for size, color and border color.
calloutLarge	Generates the verticalOffset for a globe scale level and the callout property. They should be set on PointSymbol3D or LabelSymbol3D. Contains placeholders for size, color and border color.
elevationInfo	Creates an object for elevationInfo to be set on layers. Contains placeholders for mode, offset, arcade driven expression and unit.
background	Creates an environment object for changing the background of a scene. It should be set on a SceneView and it contains a placeholder for color.
basemapStyle	List all basemap strings

TypeScript snippets

Prefix	Description
map	Import the map and map view modules then create a new Map and MapView. Contains placeholders for basemap, center and zoom.
scene	Import the map and scene view modules then create a new Scene and Scene view. Contains a placeholder for the basemap
webmap	Import the WebMap and MapView modules and create a new MapView from a web map id. Contains a placeholder for the web map id and map container.
webscene	Import the WebScene and SceneView modules and create a new SceneView from a portal item id. Contains a placeholder for the item id and map container.
addLayerFromPortalItem	Add a new layer to the map from an ArcGIS Online or Enterprise portal item. Contains a placeholder for the portal item id.
simple	Generates a SimpleRenderer. Contains a placeholder for the symbol.
uniqueValue	Generates a UniqueValueRenderer. Contains a placeholder for the field, the symbol and it generates a uniqueValueInfos array with placeholers for value, symbol and label for the legend.
classBreaks	Generates a ClassBreaksRenderer. Contains a placeholder for the field, the default symbol and it generates a classBreakInfos array with placeholers for minValue, maxValue, symbol and label for the legend.
dotDensity	Generates a DotDensityRenderer. Contains a placeholder for the dotValue, the unit, the field, the color and the label.
sizeVar	Creates a SizeVariable with 2 size stops. The axis property is only used in 3D. It contains placeholders for field, normalizationField, the legend title and the size stop values.
colorVar	Creates a ColorVariable with 2 color stops. It contains placeholders for field, normalizationField, the legend title and the color stop values.
clusterConfig	Generates the configuration for clustering in a MapView. This should be set on layers containing point geometry.
labeling2d	Creates the labelingInfo for labels in a MapView.
labeling3d	Creates the labelingInfo for labels in a SceneView.
sms	Creates a SimpleMarkerSymbol in a MapView. Contains placeholder for style.
pms	Creates a PictureMarkerSymbol in a MapView.
sls	Creates a SimpleLineSymbol in a MapView. Contains placeholder for style, cap and join.
sfs	Creates a SimpleFillSymbol in a MapView. Contains placeholder for style.
pfs	Creates a PictureFillSymbol in a MapView.
iconPoint3d	Creates a PointSymbol3D with IconSymbol3DLayer in a SceneView. Contains placeholders for primitive, color and size.
objectPoint3d	Creates a PointSymbol3D with ObjectSymbol3DLayer in a SceneView. Contains placeholders for primitive, color, height, depth and width.
line3d	Creates a LineSymbol3D with a LineSymbol3DLayer in a SceneView. Contains placeholders for color and size.
path3d	Creates a LineSymbol3D with a PathSymbol3DLayer in a SceneView. Contains placeholders for profile, color, width, height, join, cap, anchor and profileRotation.
fillPolygon3d	Creates a PolygonSymbol3D with a FillSymbol3DLayer in a SceneView. Contains placeholders for style, material color and outline color.
waterSymbol3dLayer	Creates a PolygonSymbol3D with a WaterSymbol3DLayer in a SceneView. Contains placeholder for waterbodySize and waveStrength.
extrudePolygon3d	Creates a PolygonSymbol3D with an ExtrudeSymbol3DLayer in a SceneView. Contains placeholders for material color and size.
fillMesh3d	Creates a MeshSymbol3D with a FillSymbol3DLayer in a SceneView. Contains placeholder for color.
sketchEdges	Creates SketchEdges3D that can be applied to a FillSymbol3DLayer. Contains placeholders for the color, the size and the extensionLength.
soildEdges	Creates SolidEdges3D that can be applied to a FillSymbol3DLayer. Contains placeholders for the color and the size.
calloutSmall	Generates the verticalOffset for a city scale level and the callout property. They should be set on PointSymbol3D or LabelSymbol3D. Contains placeholders for size, color and border color.
calloutLarge	Generates the verticalOffset for a globe scale level and the callout property. They should be set on PointSymbol3D or LabelSymbol3D. Contains placeholders for size, color and border color.
elevationInfo	Creates an object for elevationInfo to be set on layers. Contains placeholders for mode, offset, arcade driven expression and unit.
sceneBackground	Creates an environment object for changing the background of a scene. It should be set on a SceneView and it contains a placeholder for color.

JSON snippets

Prefix	Description
tsconfig	Default tsconfig file
tsconfigBasic	Simple tsconfig file

TSX snippets

Prefix	Description
widgetStarter	Basic starter for creating an esri widget. Contains placeholders for the widget name and default css class name.
renderableProperty	Add a renderable property. Contains placeholder for the property name.
constructor	Add a constructor
reactmap	Create a react map or scene component

Release Notes

1.0.0

Initial release of the ArcGIS API for JavaScript snippet extension.

Instructions

Visual Studio Code marketplace
Install the extension using the Install from VSIX command in Visual Studio Code then import the arcgis-jsapi-snippets-1.0.0.vsix file.
Or copy/paste the snippets you want to use into the appropriate snippet file. To open the snippet files in Visual Studio Code select User Snippets under File > Preferences (Code > Preferences on macOS) and select the language**

Requirements

Visual Studio Code

Resources

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Licensing

The snippets are 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.

Information on the ArcGIS API for JavaScript licensing can be found here: https://developers.arcgis.com/javascript/latest/guide/licensing/.

ArcGIS API for JavaScript Snippets

Esri