arcgis js vscode snippets

arcgis-js-vscode-snippets

ARCGISマップSDKをJavaScript用の一般的なコードパターン用のスニペットのコレクションを含むVisual Studioコード拡張機能。

目次

• 始めましょう
  • 前提条件
  • 使用法
  • 構成
• スニペットが利用可能
  • HTMLスニペット
  • JavaScriptスニペット
  • タイプスクリプトスニペット
  • JSONスニペット
  • TSXスニペット
• コミュニティスニペット
• 問題
• 貢献
• ライセンス

始めましょう

前提条件

この拡張機能を使用するには、インストールする必要があります。

1. Visual Studioコード（バージョン1.35以上）。
2. 拡張機能。 2つの可能性があります：
   • ビジュアルスタジオコードマーケットプレイスから。
   • Visual StudioコードにVSIXコマンドからインストールを使用して、ArcGIS-JSAPI-SNIPPETS-1.1.0.VSIXファイルをインポートします。

使用法

インストール後、それを使用する方法は2つあります。

オプション1 ）組み込みとコードIntelliSenseの使用：

1. 空のindex.jsファイルを使用して空のプロジェクトを作成します。
2. 使用可能なコードスニペットのプレフィックスを入力し始めます。 （例えば、 elev ）。
3. Tabを押してスニペットを選択するか、キーEnter 。
4. 灰色で強調表示されている値がある場合、 Tab （フォワード）とShift+Tab （後方）を使用してそれらの間を移動できます。

トラブルシューティング：
Intellisenseが機能しない場合：

• 必ず"editor.tabCompletion": "on"を設定してください（ Preferences > Open Settings(JSON) ）
• [押し]タブが機能しない場合は、同じプレフィックスを持ついくつかのスニペットがある場合があります。 Ctrl-Space （MacのCmd-Space ）を押して、必要なものを選択します。

この機能の詳細については、公式のVSCODEドキュメントをご覧ください。

---

オプション2 ）スニペットビューア拡張機能のインストール

この拡張機能は、ビルトインとカスタムスニペットをすばやく閲覧および挿入できるようにするアクティビティバーに新しいオプションを追加します。

スニペットが利用可能

HTMLスニペット

プレフィックス	説明
getapi	CDNからJavaScript用のESRI ArcGISマップSDKのCSSとJavaScriptを追加します。このスニペットは、パッケージパスも突き刺します。
方解石	CDNからESRI方解石設計システムにCSSとJavaScriptを追加します。

JavaScriptスニペット

プレフィックス	説明
必要とする	必要を使用してマップとMapViewモジュールをロードします
requideapikeys	必要な要求を使用して構成、マップ、およびMapViewモジュールをロードする
MapViewMap	マップを使用して2D MapViewを作成します
シーンビューマップ	マップを使用して3Dシーンビューを作成します。
MapViewWebMap	WebMapとPortalitemを使用して2Dマップを作成します。
SceneViewWebscene	WebCeneとPortalitemを使用して3Dマップを作成します。
addlayerfromportalitem	ポータルアイテムIDを使用してマップに新しいレイヤーを追加します。ポータルアイテムIDのプレースホルダーが含まれています。
SimpleRendererProps	1つのシンボルを持つレイヤー内のすべての機能をレンダリングします。このスニペットは、通常、長編レレイヤー、シーンレイヤー、MapimageLayer、csvlayer、Geojsonlayer、ogcfeaturelayer、wfslayer、またはfretrelayerのプロパティ「レンダラー」を設定するために使用されます。
UniquevaluerendererProps	一意の値レンダラーを生成します。このスニペットは、通常、長編レレイヤー、シーンレイヤー、MapimageLayer、csvlayer、Geojsonlayer、ogcfeaturelayer、wfslayer、wfslayer、firellayer、imagerylayer、またはimagerytilelayereerのプロパティ「レンダラー」を設定するために使用されます。
ClassBreakSrendererProps	ClassBreakSrendererを生成します。このスニペットは、通常、長編レレイヤー、シーンライヤー、メピマゲライヤー、csvlayer、geojsonlayer、ogcfeaturelayer、wfslayer、wfslayer、emollayer、bserylayer、またはimagerytilelayerのプロパティ「レンダラー」を設定するために使用されます。
sizevisualvariableprops	数値に基づいて機能のサイズを設定します。 2サイズの停止でサイズバリ性を作成します。軸プロパティは3Dでのみ使用されます。このスニペットは通常、レンダラーのプロパティ「VisualVariables []」を設定するために使用されます。
ColorVarProps	2つのカラーストップでカラーバリブルを生成します。数値属性フィールドまたは式の値に基づいて、連続色のランプに沿って機能を視覚化するために使用されます。このスニペットは通常、レンダラークラスのプロパティ「VisualVariables []」を設定するために使用されます。
featureReductionClusterProps	MapViewでクラスタリング用の構成を生成します。これは、ポイントジオメトリを含むレイヤーに設定する必要があります。このスニペットは、通常、featurelayer、csvlayer、geojsonlayer、wfslayer、またはogcfeaturelayerのジオメトリのプロパティ「featureReduction」を設定するために使用されます。
LabelClass2d	2DマップのレイヤーでラベルのLabelingInfoを作成します。 2D MapViewsのfeaturelayer、csvlayer、geojsonlayer、geojsonlayer、ogcfeaturelayer、またはwfslayerのfeaturelayer、csvlayer、geojsonlayer、geojsonlayer、ogcfeaturelayerのプロパティ「Labelinginfo []」で通常使用されています。
LabelClass3d	3DマップのレイヤーにラベルのLabelingInfoを作成します。通常、featurelayer、scenelayer、またはそのプロパティのある層のプロパティ「Labelinginfo []」で使用されます。
SimpleMarkerSymbolProps	MapViewまたはシーンビューのいずれかでシンプルな形状と色で2DポイントのジオメトリをレンダリングするためのSimpleMarkerSymbolを作成しますが、3Dの場合、PointSymbol3Dを使用することをお勧めします。このスニペットは通常、レンダラーまたは個々のグラフィックのプロパティ「シンボル」を設定するために使用されます。
picturemarkersymbolprops	PictureMarkerSymbolを作成し、マップ上のポイントのカスタム画像ベースのマーカーを許可します。
SimpleLinesymbolProps	2Dまたは3Dビューで2DポリラインのジオメトリをレンダリングするためのSimpleLineSymbolを作成しますが、3Dの場合、Linesymbol3Dを使用することをお勧めします。レンダラーや個々のグラフィックスの「シンボル」などのいくつかのプロパティで使用できますが、マーカーと塗りつぶしシンボルの「アウトライン」も使用できます。
SimpleFillSymbolProps	2Dまたは3Dビューで2DポリゴンジオメトリをレンダリングするためのSimpleFillSymbolを作成しますが、3DではPolygonsymbol3Dを使用することをお勧めします。それは、固体またはパターンで満たすことができます。このスニペットは通常、レンダラーまたは個々のグラフィックのプロパティ「シンボル」を設定するために使用されます。
picturefillsymbolprops	CpictureFillsymbolは、繰り返しパターンの画像を使用して、2D MapViewのポリゴン機能を象徴しています。ポリゴンのパターン。このスニペットは通常、レンダラーまたは個々のグラフィックのプロパティ「シンボル」を設定するために使用されます。
PointSymbol3DiconProps	シーンビューでICONSYMBOL3DLAYERを使用してPointSymbol3Dを生成します。利用可能な形状：サークル、スクエア、クロス、X、カイト、トライアングル。このスニペットは通常、レンダラーまたは個々のグラフィックのプロパティ「シンボル」を設定するために使用されます。
linesymbol3dprops	シーンビューでlinesymbol3dlayerを使用してlinesymbol3dを生成します。このスニペットは通常、レンダラーまたは個々のグラフィックのプロパティ「シンボル」を設定するために使用されます。
linesymbol3dpathprops	Pathsymbol3dlayerを使用してlinesymbol3dを生成します。ラインに沿って2Dプロファイルを押し出してポリラインのジオメトリをレンダリングします。このスニペットは通常、レンダラーまたは個々のグラフィックのプロパティ「シンボル」を設定するために使用されます。
meshsymbol3dprops	シーンビューのシーンレイヤーにfillsymbol3dlayerを使用してmeshsymbol3dを生成します。このスニペットは通常、レンダラーまたは個々のグラフィックのプロパティ「シンボル」を設定するために使用されます。
watersymbol3dlayerprops	Watersymbol3dlayerは、ポリゴンの幾何学を現実的でアニメーション化された水面としてレンダリングするために使用されるため、Polygonsymbol3D内でのみ使用できます。このスニペットは通常、レンダラーまたは個々のグラフィックのプロパティ「シンボル」を設定するために使用されます。
polygonsymbol3dextrudeprops	シーンビューで使用するextrudesymbol3dlayerを使用してpolygonsymbol3dを生成します。地面から上向きに押し出し、3D容量オブジェクトを作成することにより、ポリゴンの形状をレンダリングします。このスニペットは通常、レンダラーまたは個々のグラフィックのプロパティ「シンボル」を設定するために使用されます。
Edges3DProps	既存のシンボルに視覚化をレンダリングするエッジを追加します。 meshsymbol3dのfillsymbol3dlayerの「エッジ」プロパティまたはpolygonsymbol3dの抽出物の特性にのみ適用できます。
callout3dsmallprops	都市規模のレベルとCalloutプロパティの垂直オフセットを備えたCallout3Dを生成します。それらは、PointSymbol3DまたはLabElsymbol3Dのプロパティ「コールアウト」に設定する必要があります。
callout3dlargeProps	ワールドスケールレベルとCalloutプロパティの垂直オフセットを備えたCallOut3Dを生成します。それらは、PointSymbol3DまたはLabElsymbol3Dのプロパティ「コールアウト」に設定する必要があります。
elevationinfoprops	垂直軸（z）に特徴がどのように配置されるかを指定します。このスニペットは、featurelayer、csvlayer、wfslayer、scenelayer、streamlayer、geojsonlayer、Integratedmeshlayerなどのプロパティ「elevationinfo」を設定するために使用する必要があります。
SceneViewEnvironmentProps	シーンの背景を変更するための環境オブジェクトを作成します。このスニペットは通常、シーンビューのプロパティ「環境」を設定するために使用されます。
Basemapswithapikeys	APIキーなしで使用する利用可能なすべてのマップスタイルをリストします。これらのベースマップを使用するには、ArcGIS開発者サブスクリプションまたは有効なARCGISオンライン組織サブスクリプションが必要です
Basemapswithoutapikeys	APIキーなしで使用する利用可能なすべてのマップスタイルをリストします。これらのベースマップを使用するには、ArcGIS開発者サブスクリプションまたは有効なARCGISオンライン組織サブスクリプションが必要です
SearchWidget	検索ウィジェットは、ESRIが提供するサービスまたは機能で検索操作を実行する方法を提供します。
SearchWidgetWithCustomsources	検索ウィジェットは、サードパーティサービスに検索機能を提供する機能を提供します。検索ウィジェットでカスタムソースを使用するには、独自のカスタムソースを使用してウィジェットのソースプロパティを設定する必要があります。カスタム検索ソースを作成するには、2つの関数、GetSuggestions、およびGetResultsを含むオブジェクト上に検索ソースを構築する必要があります。
SearchWidgetWithSources	特定のフィールドに基づいて複数のレイヤーソースを検索する検索ウィジェット。検索ウィジェットで複数のソースを使用するには、ウィジェットのソースプロパティを設定する必要があります。

タイプスクリプトスニペット

プレフィックス	説明
地図	マップとマップビューモジュールをインポートし、新しいマップとMapViewを作成します。ベースマップ、センター、ズーム用のプレースホルダーが含まれています。
シーン	マップとシーンビューモジュールをインポートし、新しいシーンとシーンビューを作成します。ベースマップのプレースホルダーが含まれています
ウェブマップ	WebMapとMapViewモジュールをインポートし、WebマップIDから新しいMapViewを作成します。 WebマップIDおよびマップコンテナのプレースホルダーが含まれています。
WebCene	WebSceneとシーンビューモジュールをインポートし、ポータルアイテムIDから新しいシーンビューを作成します。アイテムIDおよびマップコンテナのプレースホルダーが含まれています。
addlayerfromportalitem	ArcGIS OnlineまたはEnterpriseポータルアイテムからマップに新しいレイヤーを追加します。ポータルアイテムIDのプレースホルダーが含まれています。
単純	SimplerEndererを生成します。シンボルのプレースホルダーが含まれています。
ユニーク評価	Uniquevaluerendererを生成します。フィールドのプレースホルダー、シンボル、および凡例の価値、シンボル、ラベルのためにPlaceHolerを使用したUniquevalueInfosアレイが含まれています。
クラスブレイク	ClassBreakSrendererを生成します。フィールドのプレースホルダー、デフォルトのシンボルが含まれており、MinValue用のPlaceHolersを使用してClassBreakinFosアレイを生成します。
ドットデンシー	dotdencessrendererを生成します。 DotValue、ユニット、フィールド、色、ラベルのプレースホルダーが含まれています。
サイズヴァー	2サイズの停止でサイズバリ性を作成します。軸プロパティは3Dでのみ使用されます。フィールドのプレースホルダー、正規化フィールド、伝説のタイトル、サイズの停止値が含まれています。
ColorVar	2つのカラーストップで可変性を作成します。フィールド、正規化フィールド、伝説のタイトル、カラーストップ値のプレースホルダーが含まれています。
ClusterConfig	MapViewでクラスタリング用の構成を生成します。これは、ポイントジオメトリを含むレイヤーに設定する必要があります。
Labeling2d	MapViewでラベルのLabelingInfoを作成します。
Labeling3d	シーンビューでラベルのLabelingInfoを作成します。
SMS	MapViewにSimpleMarkerSymbolを作成します。スタイルのプレースホルダーが含まれています。
PMS	MapViewにPictureMarkerSymbolを作成します。
SLS	MapViewでSimpleLinesymbolを作成します。スタイル、キャップ、参加のプレースホルダーが含まれています。
SFS	MapViewでSimpleFillSymbolを作成します。スタイルのプレースホルダーが含まれています。
PFS	MapViewでPictureFillSymbolを作成します。
iconpoint3d	シーンビューでiconsymbol3dlayerを使用してpointsymbol3dを作成します。原始、色、サイズのプレースホルダーが含まれています。
objectpoint3d	シーンビューでObjectSymbol3Dlayerを使用してPointSymbol3Dを作成します。原始、色、高さ、深さ、幅のプレースホルダーが含まれています。
line3d	シーンビューでlinesymbol3dlayerを使用してlinesymbol3dを作成します。色とサイズのプレースホルダーが含まれています。
path3d	シーンビューでpathsymbol3dlayerを使用してlinesymbol3dを作成します。プロファイル、色、幅、高さ、結合、キャップ、アンカー、プロフィルロテーションのプレースホルダーが含まれています。
fillpolygon3d	シーンビューでfillsymbol3dlayerを備えたpolygonsymbol3dを作成します。スタイル、素材の色、アウトライン色のプレースホルダーが含まれています。
Watersymbol3dlayer	シーンビューで水型を使用してpolygonsymbol3dを作成します。 Waterbody -SizeおよびWavestengthのプレースホルダーが含まれています。
IntrudePolygon3d	シーンビューで、extrudesymbol3dlayerを備えたpolygonsymbol3dを作成します。材料の色とサイズのプレースホルダーが含まれています。
fillmesh3d	シーンビューでfillsymbol3dlayerを備えたmeshsymbol3dを作成します。色のプレースホルダーが含まれています。
Sketchedges	fillsymbol3dlayerに適用できるSketchedges3dを作成します。色、サイズ、および拡張長のプレースホルダーが含まれています。
soildedges	fillsymbol3dlayerに適用できるsolidedges3dを作成します。色とサイズのプレースホルダーが含まれています。
CalloutsMall	都市規模レベルとコールアウトプロパティの垂直オフセットを生成します。それらは、PointSymbol3DまたはLabElsymbol3Dに設定する必要があります。サイズ、色、境界線のプレースホルダーが含まれています。
calloutlarge	グローブスケールレベルとコールアウトプロパティの垂直オフセットを生成します。それらは、PointSymbol3DまたはLabElsymbol3Dに設定する必要があります。サイズ、色、境界線のプレースホルダーが含まれています。
elevationinfo	elevationInfoがレイヤーに設定されるオブジェクトを作成します。モード、オフセット、アーケード駆動型の表現、およびユニット用のプレースホルダーが含まれています。
シーンバックグラウンド	シーンの背景を変更するための環境オブジェクトを作成します。シーンビューに設定する必要があり、色のプレースホルダーが含まれています。

JSONスニペット

プレフィックス	説明
tsconfig	デフォルトのtsconfigファイル
tsconfigbasic	単純なtsconfigファイル

TSXスニペット

プレフィックス	説明
WidgetStarter	ESRIウィジェットを作成するための基本的なスターター。ウィジェット名とデフォルトのCSSクラス名のプレースホルダーが含まれています。
renderableproperty	レンダリング可能なプロパティを追加します。プロパティ名のプレースホルダーが含まれています。
コンストラクタ	コンストラクターを追加します
ReactMap	Reactマップまたはシーンコンポーネントを作成します

コミュニティスニペット

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

問題

何かが期待されていたように機能していない場合は、最初にログに記録された問題をご覧ください。新しいバグを見つけましたか？既存のスニペットの強化をリクエストしたいですか？新しいスニペットまたはツールを提案しますか？新しい問題を開くと、ご連絡をお待ちしております。

貢献

Esriは、誰とでも誰からでも貢献を歓迎します。貢献するためのガイドラインをご覧ください。

追加のリソース

Visual Studioコードでのコードスニペットの一般的な使用の詳細については、Visual Studioの公式ドキュメントをご覧ください。

JavaScript用のArcGISマップSDKを使用する独自のカスタムコードスニペットを作成する場合は、このリポジトリに貢献することを検討するか、スニペットを共有する他の開発者に参加してください。

ライセンス

著作権2023 ESRI

スニペットは、Apacheライセンスバージョン2.0（「ライセンス」）に基づいてライセンスされています。ライセンスに準拠している場合を除き、このファイルを使用することはできません。ライセンスのコピーを取得できます

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

適用法で要求されていないか、書面で合意されていない限り、ライセンスに基づいて配布されたソフトウェアは、明示または黙示のいずれかの保証または条件なしに、「現状のまま」に基づいて配布されます。ライセンスに基づく権限と制限を管理する特定の言語のライセンスを参照してください。

ライセンスのコピーは、RepositoryのLicense.txtファイルで入手できます。

JavaScriptライセンスのARCGISマップSDKに関する情報は、https：//developers.arcgis.com/javascript/latest/guide/licensing/をご覧ください。