atlas module

パッケージ:

azure-maps-control

クラス

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

インターフェイス

AggregateExpression	集計式は、一連のデータに対して処理される計算を定義します。 スキーマ: [operator: string, initialValue?: boolean | number, mapExpression: Expression] 演算子: クラスター内の各ポイントの 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
FullscreenControlOptions	FullscreenControl オブジェクトのオプション。
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で Polygon オブジェクトと MultiPolygon オブジェクトをレンダリングするときに使用されるオプションです。
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 名前空間にイメージ テンプレートを追加します。
addProtocol(string, (args: any[]) => Promise<any>)	カスタム URL スキーマで始まる URL を使用するときに呼び出されるカスタム読み込みリソース関数を追加します。
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() を呼び出して効果を得る前に設定する必要があります。 既定では、これらのリソースのライフサイクルは自動的に管理され、マップが最初に作成されるときに遅延初期化されます。 prewarm()を呼び出すと、これらのリソースは事前に作成され、最後のマップがページから削除されたときにクリアされません。 これにより、後で作成される新しい Map インスタンスで再利用できます。 atlas.clearPrewarmedResources()を呼び出すことで手動でクリアできます。 これは、Web ページがアクティブなままで、マップの使用を完全に停止した場合にのみ必要です。 これは主に、単一ページ アプリで GL-JS マップを使用する場合に便利です。この場合、ユーザーはさまざまなビュー間を移動し、マップ インスタンスが常に作成および破棄される可能性があります。
removeProtocol(string)	メイン スレッドで以前に追加されたプロトコルを削除します。
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 を設定します。 明示的に定義されたセッション ID で Map が初期化され、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

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

addProtocol(string, (args: any[]) => Promise<any>)

カスタム URL スキーマで始まる URL を使用するときに呼び出されるカスタム読み込みリソース関数を追加します。

function addProtocol(customProtocol: string, loadFn: (args: any[]) => Promise<any>)

パラメーター

customProtocol

string

フックするプロトコル ("custom" など)

loadFn

(args: any[]) => Promise<any>

customProtocol で指定されたタイルをフェッチするときに使用する関数

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

テンプレートをスケーリングする量を指定します。 最良の結果を得るには、アイコンをマップに表示する最大サイズにスケーリングし、必要に応じてシンボル レイヤー アイコン サイズ オプションを使用してスケールダウンします。 これにより、スケーリングによるぼやけが軽減されます。 既定値: 1

戻り値

string

getLanguage()

指定された既定の言語を取得します。 以前に設定していない場合、既定値は "NGT"です。

function getLanguage(): string

戻り値

string

getMaxParallelImageRequests()

並列で読み込む画像の最大数 (ラスター タイル、スプライト、アイコン) を取得します。

function getMaxParallelImageRequests(): number

戻り値

number

getSessionId()

指定された既定のセッション ID を取得します。 以前に設定していない場合、既定値はランダム UUID です。

function getSessionId(): string

戻り値

string

getSubscriptionKey()

指定された既定の Azure Maps サブスクリプション キーを取得します。

function getSubscriptionKey(): string

戻り値

string

getUserRegion()

警告

この 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() を呼び出して効果を得る前に設定する必要があります。 既定では、これらのリソースのライフサイクルは自動的に管理され、マップが最初に作成されるときに遅延初期化されます。 prewarm()を呼び出すと、これらのリソースは事前に作成され、最後のマップがページから削除されたときにクリアされません。 これにより、後で作成される新しい Map インスタンスで再利用できます。 atlas.clearPrewarmedResources()を呼び出すことで手動でクリアできます。 これは、Web ページがアクティブなままで、マップの使用を完全に停止した場合にのみ必要です。

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

function prewarm()

removeProtocol(string)

メイン スレッドで以前に追加されたプロトコルを削除します。

function removeProtocol(customProtocol: string)

パラメーター

customProtocol

string

登録を削除するカスタム プロトコル

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 を設定します。 明示的に定義されたセッション ID で Map が初期化され、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

ワーカー数。