atlas module

リファレンス

パッケージ:: azure-maps-control

クラス

EventManager	マップコントロールのイベントのマネージャー。 atlas の events プロパティを介して公開されます。マップクラス。ユーザーがインスタンス化することはできません。
HtmlMarker	このクラスは、マップに表示できる HTML 要素をラップします。
Map	ビジュアルおよび対話型 Web マップのコントロール。
Pixel	ピクセル座標またはオフセットを表します。 [x, y] の配列を拡張します。
Popup	マップ上の指定した位置に固定された情報ウィンドウ。
PopupTemplate	ポップアップのレイアウトテンプレート。
Shape	Geometry または Feature をラップし、更新と保守を容易にするヘルパークラス。

インターフェイス

AggregateExpression	集計式は、一連のデータに対して処理される計算を定義します。 Schema: [operator: string, initialValue?: boolean \| number, mapExpression: Expression] operator: クラスター内の各ポイントのによって `mapExpression` 計算されるすべての値に対して適用される式関数。サポートされる演算子: o 数値の場合: `+`、 `*`、 `max`、 `min` o ブール値: `all`、 `any` initialValue: 省略可能、最初の計算値が集計される初期値。 mapExpression: データセット内の各ポイントに対して適用される式。
AnimationOptions	マップコントロールのカメラに対する変更をアニメーション化するためのオプション。
AuthenticationManager	マップコントロールの認証のマネージャー。 atlas の認証プロパティを介して公開されます。マップクラス。ユーザーがインスタンス化することはできません。
AuthenticationOptions	Azure Maps サービスでマップコントロールを認証する方法を指定するためのオプション。
BubbleLayerOptions	BubbleLayer で Point オブジェクトをレンダリングするときに使用されるオプション。
CameraBoundsOptions	マップコントロールのカメラの境界を設定するためのオプション。
CameraOptions	マップコントロールのカメラを設定するためのオプション。
ClusteredProperties	ClusteredProperties に存在するプロパティ
CompassControlOptions	CompassControl オブジェクトのオプション。
Control	マップのコントロールを定義するためのインターフェイス。
ControlManager	マップコントロールのコントロールのマネージャー。 atlas の controls プロパティを介して公開されます。マップクラス。ユーザーがインスタンス化することはできません。
ControlOptions	マップにコントロールを追加するためのオプション。
DataSourceOptions	マップに表示される図形データを管理するためのデータソース。データソースは、マップに表示される前にレイヤーに追加する必要があります。 `DataSourceOptions` のオプション。
ElevationTileSourceOptions
HeatMapLayerOptions	HeatMapLayer で Point オブジェクトをレンダリングするときに使用するオプション。
HtmlMarkerEvents
HtmlMarkerManager	マップコントロールの HTML マーカーのマネージャー。 atlas のマーカープロパティを介して公開されます。マップクラス。ユーザーがインスタンス化することはできません。
HtmlMarkerOptions	HtmlMarker オブジェクトをレンダリングするためのオプション
HyperLinkFormatOptions	ハイパーリンク文字列の書式オプション。
IconOptions	SymbolLayer のアイコンをカスタマイズするために使用するオプション
ImageLayerOptions	ImageLayer で Point オブジェクトをレンダリングするときに使用されるオプション。
ImageSpriteManager	マップコントロールのイメージスプライトのマネージャー。 atlas の imageSprite プロパティを介して公開されます。マップクラス。ユーザーがインスタンス化することはできません。
LayerManager	マップコントロールのレイヤーのマネージャー。 atlas の layers プロパティを介して公開されます。マップクラス。ユーザーがインスタンス化することはできません。
LayerOptions	他のすべてのレイヤーオプションの継承元となる基本クラス。
LightOptions	マップの照明のオプション。
LineLayerOptions	線レイヤーで SimpleLine、SimplePolygon、CirclePolygon、LineString、MultiLineString、Polygon、および MultiPolygon オブジェクトをレンダリングするときに使用されるオプション。
MapConfiguration	使用可能なスタイルの一覧を保持するマップ構成の内容を表します。
MapConfigurationStyle	1 つのスタイルの情報を表します。
MapDataEvent	データイベントが発生したときにマップによって返されるイベントオブジェクト。
MapErrorEvent	エラーイベントが発生したときにマップによって返されるイベントオブジェクト。
MapEvent	基本イベントが発生したときにマップによって返されるイベントオブジェクト。
MapMouseEvent	マウスイベントが発生したときにマップによって返されるイベントオブジェクト。
MapMouseWheelEvent	ホイールイベントが発生したときにマップによって返されるイベントオブジェクト。
MapTouchEvent	タッチイベントが発生したときにマップによって返されるイベントオブジェクト。
MediaLayerOptions	キャンバス、イメージ、ラスタータイル、ビデオレイヤーをレンダリングするときに使用されるオプション
Options
Padding	マップのカメラを設定するときに BoundingBox の側面に追加するパディングの量をピクセル単位で表します。
PitchControlOptions	PitchControl オブジェクトのオプション。
PolygonExtrusionLayerOptions	内`PolygonExtrusionLayer`のオブジェクトと `MultiPolygon` をレンダリング`Polygon`するときに使用されるオプション。
PolygonLayerOptions	PolygonLayer で Polygon オブジェクトと MultiPolygon オブジェクトをレンダリングするときに使用されるオプション。
PopupEvents
PopupManager	マップコントロールのポップアップのマネージャー。クラスの `atlas.Map` プロパティを`popups`介して公開されます。ユーザーがインスタンス化することはできません。
PopupOptions	ポップアップのオプション。
Properties	で使用できる一連のプロパティ `PopupTemplate`
PropertyInfo	プロパティの表示方法の種の詳細。
RasterTileSourceOptions
RequestParameters	これは、transformRequest コールバックによって返されることが予想されるオブジェクト型です。
ScaleControlOptions	ScaleControl オブジェクトのオプション。
ServiceOptions	すべての atlas サービス要求で使用されるグローバルプロパティ。
ShapeEvents
SourceManager	マップコントロールのソースのマネージャー。 atlas の sources プロパティを介して公開されます。マップクラス。ユーザーがインスタンス化することはできません。
StyleChangedEvent	新しいスタイルを読み込んだ後にマップによって返されるイベントオブジェクト。
StyleControlOptions	StyleControl オブジェクトのオプション。
StyleOptions	マップのスタイルのオプション。
SymbolLayerOptions	SymbolLayer でジオメトリをレンダリングするときに使用されるオプション。
TargetedEvent
TextOptions	SymbolLayer のテキストをカスタマイズするために使用するオプション
Tile	ソースデータイベントが発生したときにマップによって返されるタイルオブジェクト。
TileId
TileLayerOptions	TileLayer でラスタータイルイメージをレンダリングするときに使用されるオプション。
TrafficControlOptions
TrafficOptions	マップ上でトラフィックを設定するためのオプション。
UserInteractionOptions	マップに対するユーザー操作を有効または無効にするオプション。
VectorTileSourceOptions	マップに表示される図形データを管理するためのデータソース。データソースは、マップに表示される前にレイヤーに追加する必要があります。 `VectorTileSource` のオプション。
WebGLLayerOptions	WebGLLayer でグラフィックスをレンダリングするために使用するオプション。
WebGLRenderer	WebGLLayer で WebGL グラフィックをレンダリングするためのインターフェイス。
ZoomControlOptions	ZoomControl オブジェクトのオプション。

型エイリアス

Expression	フィルターまたは特定のレイヤーオプションの値として指定できます。式は、プロパティの値を計算するための数式を定義します。式は JSON 配列として表されます。式の最初の要素は、式演算子に名前を付ける文字列です。
getAuthTokenCallback	匿名認証モードで認証トークンを取得するために使用されるコールバック関数。認証トークンを使用して解決するか、エラーで拒否します。
ResourceType
StyleImageMetadata	に`ImageSpriteManager.add`渡されるパラメーターの`options`シグネチャ。

列挙型

AuthenticationType	使用する認証メカニズムの種類を指定するために使用される列挙体。
ControlPosition	コントロールをマップ上に配置できる位置。
ControlStyle	コントロールで使用できるスタイル。

機能

addImageTemplate(string, string, boolean)	atlas 名前空間にイメージテンプレートを追加します。
clearPrewarmedResources()	によって `atlas.prewarm()`以前に作成されたリソースをクリアします。通常、これは必要ありません。この関数は、アプリのユーザーがアプリケーションのどの時点でもマップビューに戻らないと予想される場合にのみ呼び出す必要があります。
getAllImageTemplateNames()	atlas 名前空間で使用できるすべてのイメージテンプレートの名前の配列を取得します。
getAuthenticationOptions()	指定された既定の認証オプションを取得します。以前に設定されていない場合、すべてのプロパティは未定義になります。
getDomain()	指定された既定のドメインを取得します。以前に設定していない場合、既定値はです `"atlas.microsoft.com"`。
getImageTemplate(string, number)	名前を指定して SVG テンプレートを取得します。
getLanguage()	指定された既定の言語を取得します。以前に設定していない場合、既定値はです `"NGT"`。
getMaxParallelImageRequests()	並列で読み込む画像の最大数 (ラスタータイル、スプライト、アイコン) を取得します
getSessionId()	指定された既定のセッション ID を取得します。以前に設定していない場合、既定値はランダムな UUID です。
getSubscriptionKey()	指定された既定のAzure Mapsサブスクリプションキーを取得します。
getUserRegion()
getVersion()	ビルド番号に基づく現在の API バージョン番号。
getView()	マップコントロールの既定のビュー設定を取得します。以前に設定していない場合、既定値はです `undefined`。
getWorkerCount()	作成されるワーカー数を取得します。
isSupported(boolean)	ユーザーのブラウザーがマップコントロールでサポートされているかどうかを確認します。
prewarm()	一部の状況で読み込み時間を短縮するためにマップ間で共有できる WebWorkers などのリソースを初期化します。 `atlas.setWorkerCount`を使用する場合は、を呼び出して効果を得る前に `prewarm()` を設定する必要があります。既定では、これらのリソースのライフサイクルは自動的に管理され、Map が最初に作成されるときに遅延初期化されます。を `prewarm()`呼び出すと、これらのリソースは事前に作成され、最後のマップがページから削除されたときにはクリアされません。これにより、後で作成される新しい Map インスタンスで再利用できます。これらは、を呼び出 `atlas.clearPrewarmedResources()`すことによって手動でクリアできます。これは、Web ページがアクティブなままで、マップの使用を完全に停止する場合にのみ必要です。これは主に、1 つのページアプリで GL-JS マップを使用する場合に便利です。ユーザーはさまざまなビュー間を移動し、Map インスタンスが常に作成および破棄される可能性があります。
setAuthenticationOptions(AuthenticationOptions)	マップコントロールと Azure Maps サービスに要求を行うモジュールで使用される atlas 名前空間の既定のオプションとして、認証オプションを設定します。 Map が認証オプションで明示的に定義され、setAuthenticationOptions が以前に呼び出されていない場合、Map コンストラクターによって自動的に呼び出されます。
setDomain(string)	API のこれらの部分を使用するときにドメインが明示的に指定されていない限り、マップモジュールとサービスモジュールで使用される既定のドメインを設定します。 Map が明示的に定義されたドメインで初期化され、setDomain が以前に呼び出されていない場合は、Map コンストラクターによって自動的に呼び出されます。プロトコルが指定 `https` されていない場合はと見なされます。
setLanguage(string)	API のこれらの部分を使用するときに言語が明示的に指定されていない限り、マップモジュールとサービスモジュールで使用される既定の言語を設定します。 Map が明示的に定義された言語で初期化され、setLanguage が以前に呼び出されていない場合、Map コンストラクターによって自動的に呼び出されます。
setMaxParallelImageRequests(number)	同時に読み込む画像の最大数 (ラスタータイル、スプライト、アイコン) を設定します。これは、ラスター重いマップのパフォーマンスに影響します。既定では 16。
setSessionId(string)	API のこれらの部分を使用するときにセッション ID が明示的に指定されていない限り、マップモジュールとサービスモジュールで使用される既定のセッション ID を設定します。 Map がセッション ID で明示的に定義され、setSessionId が以前に呼び出されていない場合は、Map コンストラクターによって自動的に呼び出されます。
setSubscriptionKey(string)	Azure Mapsサブスクリプションキーを、マップコントロールと Azure Maps サービスに要求を行うモジュールで使用される atlas 名前空間の既定のサブスクリプションキーとして設定します。 Map がサブスクリプションキーで明示的に定義され、setSubscriptionKey が以前に呼び出されていない場合、Map コンストラクターによって自動的に呼び出されます。
setUserRegion(string)
setView(string)	マップに表示する地政学的に争われる境界線とラベルのセットを指定します。 View パラメーター ("ユーザーリージョンパラメーター" とも呼ばれます) は、その国/地域の正しいマップを表示する 2 文字の ISO-3166 国コードです。 [表示] リストに表示されていない国/地域、または指定されていない場合は、既定で "統一" ビューが表示されます。サポートされている [ビュー]{@link https://aka.ms/AzureMapsLocalizationViews } を参照してください。ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、およびユーザーがAzure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。
setWorkerCount(number)	ページでインスタンス化された Web ワーカーの数を設定します。既定では、CPU コアの数の半分 (上限は 6) に設定されています。

関数の詳細

addImageTemplate(string, string, boolean)

atlas 名前空間にイメージテンプレートを追加します。

function addImageTemplate(templateName: string, template: string, override: boolean)

パラメーター

templateName: string

テンプレートの名前。

template: string

追加する SVG テンプレート。 {color}、{secondaryColor}、{scale}、{text} をサポートします。

override: boolean

同じ名前のテンプレートが既に存在する場合に、既存のテンプレートをオーバーライドするかどうかを指定します。

clearPrewarmedResources()

によって atlas.prewarm()以前に作成されたリソースをクリアします。通常、これは必要ありません。この関数は、アプリのユーザーがアプリケーションのどの時点でもマップビューに戻らないと予想される場合にのみ呼び出す必要があります。

function clearPrewarmedResources()

getAllImageTemplateNames()

atlas 名前空間で使用できるすべてのイメージテンプレートの名前の配列を取得します。

function getAllImageTemplateNames(): string[]

戻り値

string[]

getAuthenticationOptions()

指定された既定の認証オプションを取得します。以前に設定されていない場合、すべてのプロパティは未定義になります。

function getAuthenticationOptions(): AuthenticationOptions

戻り値

AuthenticationOptions

getDomain()

指定された既定のドメインを取得します。以前に設定していない場合、既定値はです "atlas.microsoft.com"。

function getDomain(): string

戻り値

string

getImageTemplate(string, number)

名前を指定して SVG テンプレートを取得します。

function getImageTemplate(templateName: string, scale?: number): string

パラメーター

templateName: string

取得するテンプレートの名前。

scale: number

この API は非推奨になりました。

use atlas.getView() instead

function getUserRegion(): string

戻り値

string

getVersion()

ビルド番号に基づく現在の API バージョン番号。

function getVersion(): string

戻り値

string

getView()

マップコントロールの既定のビュー設定を取得します。以前に設定していない場合、既定値はです undefined。

function getView(): string

戻り値

string

getWorkerCount()

作成されるワーカー数を取得します。

function getWorkerCount(): number

戻り値

number

isSupported(boolean)

ユーザーのブラウザーがマップコントロールでサポートされているかどうかを確認します。

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

パラメーター

failIfMajorPerformanceCaveat: boolean

true の場合、マップコントロールのパフォーマンスが予想よりも大幅に悪くなる場合 (たとえば、ソフトウェア WebGL レンダラーが使用される場合) は、関数から false が返されます。

戻り値

boolean

prewarm()

一部の状況で読み込み時間を短縮するためにマップ間で共有できる WebWorkers などのリソースを初期化します。 atlas.setWorkerCountを使用する場合は、を呼び出して効果を得る前に prewarm() を設定する必要があります。既定では、これらのリソースのライフサイクルは自動的に管理され、Map が最初に作成されるときに遅延初期化されます。を prewarm()呼び出すと、これらのリソースは事前に作成され、最後のマップがページから削除されたときにはクリアされません。これにより、後で作成される新しい Map インスタンスで再利用できます。これらは、を呼び出 atlas.clearPrewarmedResources()すことによって手動でクリアできます。これは、Web ページがアクティブなままで、マップの使用を完全に停止する場合にのみ必要です。

これは主に、1 つのページアプリで GL-JS マップを使用する場合に便利です。ユーザーはさまざまなビュー間を移動し、Map インスタンスが常に作成および破棄される可能性があります。

function prewarm()

setAuthenticationOptions(AuthenticationOptions)

マップコントロールと Azure Maps サービスに要求を行うモジュールで使用される atlas 名前空間の既定のオプションとして、認証オプションを設定します。 Map が認証オプションで明示的に定義され、setAuthenticationOptions が以前に呼び出されていない場合、Map コンストラクターによって自動的に呼び出されます。

function setAuthenticationOptions(options: AuthenticationOptions)

パラメーター

options: AuthenticationOptions

新しい既定の認証オプション。

setDomain(string)

API のこれらの部分を使用するときにドメインが明示的に指定されていない限り、マップモジュールとサービスモジュールで使用される既定のドメインを設定します。 Map が明示的に定義されたドメインで初期化され、setDomain が以前に呼び出されていない場合は、Map コンストラクターによって自動的に呼び出されます。プロトコルが指定 https されていない場合はと見なされます。

function setDomain(domain: string)

パラメーター

domain: string

新しい既定のドメイン。

setLanguage(string)

API のこれらの部分を使用するときに言語が明示的に指定されていない限り、マップモジュールとサービスモジュールで使用される既定の言語を設定します。 Map が明示的に定義された言語で初期化され、setLanguage が以前に呼び出されていない場合、Map コンストラクターによって自動的に呼び出されます。

function setLanguage(language: string)

パラメーター

language: string

新しい既定の言語。

setMaxParallelImageRequests(number)

同時に読み込む画像の最大数 (ラスタータイル、スプライト、アイコン) を設定します。これは、ラスター重いマップのパフォーマンスに影響します。既定では 16。

function setMaxParallelImageRequests(maxParallelImageRequests: number)

パラメーター

maxParallelImageRequests: number

並列で読み込むイメージの最大数。

setSessionId(string)

API のこれらの部分を使用するときにセッション ID が明示的に指定されていない限り、マップモジュールとサービスモジュールで使用される既定のセッション ID を設定します。 Map がセッション ID で明示的に定義され、setSessionId が以前に呼び出されていない場合は、Map コンストラクターによって自動的に呼び出されます。

function setSessionId(id: string)

パラメーター

id: string

新しい既定のセッション ID。

setSubscriptionKey(string)

Azure Mapsサブスクリプションキーを、マップコントロールと Azure Maps サービスに要求を行うモジュールで使用される atlas 名前空間の既定のサブスクリプションキーとして設定します。 Map がサブスクリプションキーで明示的に定義され、setSubscriptionKey が以前に呼び出されていない場合、Map コンストラクターによって自動的に呼び出されます。

function setSubscriptionKey(key: string)

パラメーター

key: string

新しい既定のサブスクリプションキー。

setUserRegion(string)

警告

この API は非推奨になりました。

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

パラメーター

userRegion: string

setView(string)

マップに表示する地政学的に争われる境界線とラベルのセットを指定します。 View パラメーター ("ユーザーリージョンパラメーター" とも呼ばれます) は、その国/地域の正しいマップを表示する 2 文字の ISO-3166 国コードです。 [表示] リストに表示されていない国/地域、または指定されていない場合は、既定で "統一" ビューが表示されます。サポートされている [ビュー]{@link https://aka.ms/AzureMapsLocalizationViews } を参照してください。ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、およびユーザーがAzure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。

function setView(view: string)

パラメーター

view: string

新しい既定のビュー

setWorkerCount(number)

ページでインスタンス化された Web ワーカーの数を設定します。既定では、CPU コアの数の半分 (上限は 6) に設定されています。

function setWorkerCount(workerCount: number)

パラメーター

workerCount: number

worker count。

atlas module

クラス

インターフェイス

型エイリアス

列挙型

機能

関数の詳細

addImageTemplate(string, string, boolean)

パラメーター

clearPrewarmedResources()

getAllImageTemplateNames()

戻り値

getAuthenticationOptions()

戻り値

getDomain()

戻り値

getImageTemplate(string, number)

パラメーター

戻り値

getLanguage()

戻り値

getMaxParallelImageRequests()

戻り値

getSessionId()

戻り値

getSubscriptionKey()

戻り値

getUserRegion()

戻り値

getVersion()

戻り値

getView()

戻り値

getWorkerCount()

戻り値

isSupported(boolean)

パラメーター

戻り値

prewarm()

setAuthenticationOptions(AuthenticationOptions)

パラメーター

setDomain(string)

パラメーター

setLanguage(string)

パラメーター

setMaxParallelImageRequests(number)

パラメーター

setSessionId(string)

パラメーター

setSubscriptionKey(string)

パラメーター

setUserRegion(string)

パラメーター

setView(string)

パラメーター

setWorkerCount(number)

パラメーター

その他のリソース