arcgis js vscode snippets

ArcGIS-JS-VSCODE-SNIPPET

Visual Studio代码扩展名，其中包含用于使用ArcGIS Maps SDK的JavaScript的常见代码模式的片段集合。

目录

• 开始
  • 先决条件
  • 用法
  • 配置
• 摘要可用
  • HTML片段
  • JavaScript片段
  • 打字稿片段
  • JSON片段
  • TSX片段
• 社区片段
• 问题
• 贡献
• 执照

开始

先决条件

要使用此扩展程序，您需要安装：

1. Visual Studio代码（1.35版或更高版本）。
2. 扩展。有两种可能性：
   • 来自Visual Studio代码市场。
   • 使用Visual Studio代码中的VSIX命令的安装，然后导入ArcGIS-JSAPI-SNIPPETS-1.1.0.VSIX文件。

用法

安装后，有两种使用方法：

选项1 ）使用内置与代码Intellisense：

1. 使用一个空index.js文件创建一个空项目。
2. 开始键入一个可用代码段的前缀。 （例如elev ）。
3. 通过按选项Tab选择片段或Enter键。
4. 如果有灰色突出显示的值，则可以使用Tab （向前）和Shift+Tab （向后）在它们之间移动。

故障排除：
如果Intellisense不起作用：

• 确保在设置（ Preferences > Open Settings(JSON) ）中具有"editor.tabCompletion": "on"
• 如果按下标签不起作用，则可能有几个具有相同前缀的片段。按Ctrl-Space （Mac上的Cmd-Space ）选择您需要的一个。

在官方VSCODE文档中阅读有关此功能的更多信息。

---

选项2 ）安装摘要查看器扩展程序

此扩展程序为活动栏添加了一个新选项，可让您快速浏览并插入内置和自定义片段：

摘要可用

HTML片段

前缀	描述
Getapi	将CSS和JavaScript添加到CDN中的JavaScript中的ESRI ArcGIS MAPS SDK中。该片段还暂停了包装路径。
方解石	从CDN添加CSS和JavaScript中的ESRI方解石设计系统。

JavaScript片段

前缀	描述
要求	使用需要加载地图和MapView模块
需要Apapikeys	使用require
mapViewMap	使用地图创建2D MapView
场景视图图	使用地图创建3D场景视图。
mapviewwebmap	使用网络图和门户网站创建2D地图。
场景viewwebscene	使用WebScene和Portalitem创建3D地图。
addlayerfromportalitem	使用门户项目ID向地图添加新图层。包含门户项目ID的占位符。
SimpleerererProps	呈现一个具有一个符号的图层中的所有功能。该摘要通常用于设置特色菜，Seneelerer，Mapimagelayer，csvlayer，Geojsonlayer，ogcfeaturelelayer，wfslayer或streamlayer ..的属性“渲染器”。
唯一Valuerendererprops	生成一个唯一的价值渲染器。此摘要通常用于设置特色店，Seneelerer，Mapimagelayer，csvlayer，Geojsonlayer，ogcfeaturelayer，wfslayer，streamlayer，streamLayer，imagerylayer或Imigerytilelayer的属性“渲染器”
class breaksrenderererprops	生成一个classbreaksrenderer。该摘要通常用于设置特色店，Scenelayer，Mapimagelayer，Csvlayer，Geojsonlayer，OgcFeatUrelayer，wfslayer，streamlayer，imagerylayer，imagerylayer或ImmigerTilelayer的属性“渲染器”。
sizeVisualVariable Props	基于数字值的设置功能大小。创建一个具有2个尺寸停止的尺寸。轴属性仅在3D中使用。该片段通常用于设置渲染器的属性“ VisualVariables []。
colorvarprops	生成具有2个颜色停止的ColorVariable。用于根据数字属性字段或表达式的值沿连续的彩色坡道可视化特征。该片段通常用于设置渲染器类的属性“ VisualVariables []”。
TemuleredCluctultclusterProps	生成用于在MapView中聚类的配置。应将其设置在包含点几何形状的图层上。该片段通常用于设置特色店，csvlayer，geojsonlayer，wfslayer或ogcfeaturelayer几何形状的属性“特征性”。
LabelClass2d	为2D地图的图层中的标签创建标签。它以特色列赛，csvlayer，geojsonlayer，streamlayer，ogcfeaturelayer或wfslayer在2D mapviews中的特征列表，csvlayer，geojsonlayer，eyojsonlayer，streamlayer，streamlayer，geojsonlayer，geojsonlayer，geojsonlayer或2D mapviews的属性中使用。
LabelClass3D	为3D地图的图层中的标签创建标签。它通常在属性的“ labelinginfo []”属性中使用。
SimpleMarkerSymbolprops	创建一个SimpleMarkerSymbol，用于在MapView或SceneView中使用简单的形状和颜色渲染2D点几何，但是对于3D，建议使用Pointsymbol3D。该片段通常用于设置渲染器或单个图形的属性“符号”。
Picturemarkersymbolprops	创建一个PictureMarkerSymbol，允许在地图上的点上进行自定义的基于图像的标记。
SimpleLinesymbolprops	创建一个SimpleLineSymbol，用于在2D或3D视图中渲染2D多线几何形状，但是对于3D，建议使用LinesSymbol3D。它可以用于多个属性中，例如渲染器或单个图形的“符号”，还可以使用标记和填充符号的“概述”。
SimpleFillSymbolprops	创建一个简单的FillSymbol，用于在2D或3D视图中渲染2D Polygon几何形状，但是对于3D，建议使用Polygonsymbol3D。它可以用纯色或图案填充。该片段通常用于设置渲染器或单个图形的属性“符号”。
Picturefillsymbolprops	CpictureFillSymbol在重复模式中使用图像来象征2D MapView中的多边形特征。多边形的模式。该片段通常用于设置渲染器或单个图形的属性“符号”。
pointymbol3diconprops	在场景视图中使用iConsymbol3dlayer生成pointsymbol3d。可用形状：圆，正方形，十字，X，风筝和三角形。该片段通常用于设置渲染器或单个图形的属性“符号”。
lineymbol3ddrops	在场景视图中使用linesymbol3dlayer生成linesymbol3d。该片段通常用于设置渲染器或单个图形的属性“符号”。
linesymbol3ddatpathpath	用PATHSYMBOL3DLAYER生成lineSymbol3d。通过沿线挤出2D轮廓来渲染多线几何形状。该片段通常用于设置渲染器或单个图形的属性“符号”。
meshsymbol3ddrops	在场景视图中的seniateLayer中使用fillsymbol3dlayer生成Meshsymbol3d。该片段通常用于设置渲染器或单个图形的属性“符号”。
WaterSymbol3DlayerProps	WaterSymbol3Dlayer用于将多边形几何形状作为逼真的动画水面，因此只能在Polygonsymbol3d内使用。该片段通常用于设置渲染器或单个图形的属性“符号”。
polygonsymbol3ddextrudeprops	用甲虫BOL3DLAYER生成polygonsymbol3d，用于场景视图。它通过将其从地面向上挤出来使多边形几何形状产生3D体积对象。该片段通常用于设置渲染器或单个图形的属性“符号”。
EDGES3DPROPS	将可视化添加到现有符号中。只能应用于fillsymbol3dlayer在meshsymbol3d上的“边缘”属性，或在polygonsymbol3d上的甲虫BOL3DDLAYER。
Callout3dsMallProps	为城市规模级别和标注属性生成带有垂直分配的Callout3D。它们应设置在pointsymbol3d或labelsymbol3d的属性上。
Callout3DlargeProps	生成带有垂直Offset的Callout3D，用于世界尺度级别和标注属性。它们应设置在pointsymbol3d或labelsymbol3d的属性上。
海拔infoprops	指定特征如何放置在垂直轴上（z）。该摘要应用于设置特色店，CSVLAYER，WFSLAYER，SEENELAYER，SteelLayer，GeoJsonLayer，IntegratedMeshlayer等的属性“ ElevationInfo”。
场景ViewenvironmentProps	创建一个环境对象，以更改场景的背景。该片段通常用于设置场景视图的属性“环境”。
碱基层	列出所有可用的无API键的可用地图样式。使用这些基础图需要ArcGIS开发人员订阅或有效的ArcGIS在线组织订阅
basemapswithoutapikeys	列出所有可用的无API键的可用地图样式。使用这些基础图需要ArcGIS开发人员订阅或有效的ArcGIS在线组织订阅
SearchWidget	搜索小部件提供了一种对ESRI提供的服务或功能进行搜索操作的方法。
searchWidgetWithCustomSources	搜索小部件提供了为第三方服务提供搜索功能的功能。要将自定义源与搜索小部件一起使用，您必须使用自己的自定义源设置小部件的源属性。要创建一个自定义搜索源，您需要使用包含两个功能，getuggestions和getResults的对象构建搜索源。
SearchWidgetWithSources	搜索小部件基于给定字段搜索多层源。要与搜索小部件一起使用多个源，您必须设置小部件的源属性。

打字稿片段

前缀	描述
地图	导入地图和地图视图模块，然后创建一个新的地图和MapView。包含基地，中心和Zoom的占位符。
场景	导入地图和场景视图模块，然后创建一个新的场景和场景视图。包含一个基地的占位符
网络图	导入Webmap和MapView模块，并从网络地图ID创建新的MapView。包含用于网络地图ID和地图容器的占位符。
Webscene	导入WebScene和SceneView模块，并从门户网站项目ID创建新的场景视图。包含项目ID和地图容器的占位符。
addlayerfromportalitem	从ArcGIS在线或企业门户项目中向地图添加新图层。包含门户项目ID的占位符。
简单的	生成一个简单的人。包含一个符号的占位符。
独特的价值	生成一个唯一的valuerender。包含一个田地的占位符，该符号和它生成一个独特的ValueInfos阵列，带有带有价值，符号和标签的代码。
班级	生成一个classbreaksrenderer。包含该字段的占位符，默认符号，并生成一个带有Minvalue，MaxValue，MaxValue，符号和标签的classbreakinfos数组。
点密度	生成一个dotdensityrenderer。包含一个占位符的占位符，单元，场，颜色和标签。
sizevar	创建一个具有2个尺寸停止的尺寸。轴属性仅在3D中使用。它包含场，标准化场，传奇标题和大小停止值的占位符。
colorvar	创建一个具有2个颜色停止的ColorVarable。它包含田野，标准化场，传奇标题和颜色停止值的占位符。
clusterConfig	生成用于在MapView中聚类的配置。应将其设置在包含点几何形状的图层上。
labeling2d	为MapView中的标签创建标签。
labeling3d	在场景视图中为标签创建标签。
短信	在MapView中创建SimpleMarkerSymbol。包含风格的占位符。
PMS	在MapView中创建一个PictureMarkerSymbol。
SLS	在MapView中创建SimpleLineSymbol。包含风格，上限和加入的占位符。
SFS	在MapView中创建一个简单的FillSymbol。包含风格的占位符。
PFS	在MapView中创建picturefillsymbol。
ICONPOINT3D	在场景视图中使用IconSymbol3Dlayer创建点符号3D。包含用于原始，颜色和大小的占位符。
ObjectPoint3D	在场景视图中使用objectsymbol3dlayer创建点符号3D。包含原始，颜色，高度，深度和宽度的占位符。
line3d	在场景视图中使用linesymbol3dlayer创建LINESYMBOL3D。包含颜色和尺寸的占位符。
路径3D	在场景视图中创建带有pathsymbol3dlayer的LinesMbol3d。包含供位，颜色，宽度，高度，连接，盖，锚和介质的占位符。
fillpolygon3d	在场景视图中使用fillsymbol3dlayer创建一个polygonsymbol3d。包含占位符的样式，材料颜色和轮廓颜色。
watersymbol3dlayer	在场景视图中使用WaterSymbol3Dlayer创建一个polygonsymbol3d。包含用于水域和波长的占位符。
挤压分解3D	在场景视图中创建带有挤压符号的polygonsymbol3d。包含材料颜色和尺寸的占位符。
fillmesh3d	在场景视图中使用fillsymbol3dlayer创建一个meshsymbol3d。包含颜色的占位符。
草图	创建可以应用于FillSymbol3Dlayer的Sketchedges3D。包含颜色，尺寸和延期长度的占位符。
Soildges	创建可以应用于FillSymbol3Dlayer的Solidedges3D。包含颜色和尺寸的占位符。
标题符号	生成城市规模级别和排名属性的垂直差。它们应设置在pointymbol3d或labelsymbol3d上。包含尺寸，颜色和边框颜色的占位符。
跟踪拉格	为地球量表级别和排名属性生成垂直差。它们应设置在pointymbol3d或labelsymbol3d上。包含尺寸，颜色和边框颜色的占位符。
海拔	创建一个要在图层上设置的高程info的对象。包含用于模式，偏移，街机驱动表达和单位的占位符。
SceneBackground	创建一个环境对象，以更改场景的背景。它应该在场景视图上设置，并包含颜色的占位符。

JSON片段

前缀	描述
Tsconfig	默认的tsconfig文件
tsconfigbasic	简单的tsconfig文件

TSX片段

前缀	描述
窗口明星	创建ESRI小部件的基本起动器。包含小部件名称和默认CSS类名称的占位符。
可渲染的Property	添加一个可渲染的属性。包含属性名称的占位符。
构造函数	添加一个构造函数
反应量	创建一个反应地图或场景组件

社区片段

• github.com/hhkaos/esri-vscode-snippets

问题

如果某些事情无法按照您的预期工作，请首先查看先前记录的问题。您找到了一个新错误吗？是否需要提高现有片段的增强？建议新的片段或工具？打开一个新问题，我们很想收到您的来信。

贡献

ESRI欢迎任何人和所有人的贡献。请参阅我们的贡献指南。

其他资源

要了解有关Visual Studio代码中代码段的一般使用的更多信息，请阅读Visual Studio官方文档。

如果您创建自己的自定义代码片段以与ArcGIS Maps SDK一起使用JavaScript，请考虑为此存储库做出贡献或加入其他共享其片段的开发人员。

执照

版权2023 ESRI

摘要是根据Apache许可证的2.0版（“许可证”）获得许可的；除了符合许可外，您不得使用此文件。您可以在

http://www.apache.org/licenses/license-2.0

除非适用法律要求或以书面形式同意，否则根据许可证分配的软件是按照“原样”分发的，没有任何明示或暗示的任何形式的保证或条件。请参阅许可证，以获取执行许可条款和限制的特定语言。

该许可证的副本可在Repository的许可证文件中使用。

可以在此处找到有关JavaScript许可的ArcGIS MAPS SDK的信息：https：//developers.arcgis.com/javascript/latest/guide/guide/licensing/。