ServiceOptions interface

パッケージ:

azure-maps-control

すべての atlas サービス要求で使用されるグローバル プロパティ。

Extends

Options

プロパティ

authOptions	Azure Maps サービスでマップ コントロールの認証方法をカスタマイズするために使用される認証オプション。 これらの認証オプションが指定されている場合は、ServiceOptions.subscriptionKey を指定しないでください。 代わりに atlas.setAuthenticationOptions 関数を使用することをお勧めします。
disableTelemetry	テレメトリ 収集を無効にする このオプションは、マップを初期化する場合にのみ設定できます。 default: false (Azure Government クラウドの場合は true)
domain	マップ タイルとその他のAzure Maps サービスを要求するときに使用するドメイン。 プロトコルが指定 https されていない場合は と見なされます。 代わりに atlas.setDomain 関数を使用することをお勧めします。
enableAccessibility	アクセシビリティ機能を有効にして、Web アプリケーションの視覚化が困難なユーザーにスクリーン リーダーのサポートを提供します。 このプロパティは既定で true に設定されています。
enableAccessibilityLocationFallback	ベクター データからの場所の抽出に失敗した場合に場所のアクセシビリティを検出するために、REST API ジオコーダーへのフォールバックを有効にします。 このオプションを無効にすると、ジオコーディング API 要求が生成されなくなりますが、スクリーン リーダーの位置情報が不足する可能性があります。 default: true
fadeDuration	ラベルの衝突に対するフェードイン/フェードアウト アニメーションの継続時間をミリ秒単位で制御します。 この設定は、すべてのシンボル レイヤーに影響します。 この設定は、ランタイム スタイル切り替えまたはラスター タイルのクロスフェードの期間には影響しません。
localIdeographFontFamily	'CJK Unified Ideographs'、'ひらがな'、'Katakana'、および 'Hangul Syllables' の範囲でグリフの生成をローカルでオーバーライドするための CSS フォント ファミリを定義します。 これらの範囲では、フォントの太さキーワード (淡色/標準/中/太字) を除き、マップのスタイルのフォント設定は無視されます。 これらのグリフ範囲に対してマップのスタイルからフォント設定を有効にするには、false に設定します。 このオプションの目的は、帯域幅を集中的に消費するグリフ サーバー要求を回避することです。
mapConfiguration	マップ構成では、マップで使用できるスタイルのセットを定義します。
maxParallelImageRequests	並行して読み込む画像 (ラスター タイル、スプライト、アイコン) の最大数。これは、ラスター重いマップのパフォーマンスに影響します。 既定では 16。
refreshExpiredTiles	ベクター タイルとラスター タイルが期限切れになったときに再読み込みする必要があるかどうかを指定するブール値 (expires ヘッダーに基づく)。 これは、頻繁に更新されるデータ セットに役立ちます。 false に設定すると、各タイルは 1 回読み込まれ、必要な場合は読み込まれ、有効期限が切れると再読み込みされません。 default: true
sessionId	要求と共に渡すセッション ID。 代わりに atlas.setSessionId を使用することをお勧めします。
styleAPIVersion	スタイルとスタイルセットを要求するときに使用されるスタイル API バージョン
styleDefinitionsVersion	styleDefinitionsPath からスタイルを要求するときに要求するスタイル定義バージョン。
subscriptionKey	要求の承認に使用される顧客サブスクリプション キー。 このオプションは、マップを初期化する場合にのみ設定できます。 代わりに atlas.setSubscriptionKey 関数を使用することをお勧めします
transformRequest	定義された transformRequest が呼び出され、タイルを読み込むためのカスタム要求パラメーターが提供されます。
validateStyle	True を設定すると、適用される前にスタイルが検証されます。 初期読み込み中にスタイルを処理するには、検証にかなりの時間 (数百ミリ秒) かかります。
workerCount	ページでインスタンス化された Web ワーカーの数。 既定では、CPU コアの数の半分 (上限は 6) に設定されています。

プロパティの詳細

authOptions

Azure Maps サービスでマップ コントロールの認証方法をカスタマイズするために使用される認証オプション。 これらの認証オプションが指定されている場合は、ServiceOptions.subscriptionKey を指定しないでください。 代わりに atlas.setAuthenticationOptions 関数を使用することをお勧めします。

authOptions?: AuthenticationOptions

プロパティ値

AuthenticationOptions

disableTelemetry

テレメトリ 収集を無効にする このオプションは、マップを初期化する場合にのみ設定できます。 default: false (Azure Government クラウドの場合は true)

disableTelemetry?: boolean

プロパティ値

boolean

domain

マップ タイルとその他のAzure Maps サービスを要求するときに使用するドメイン。 プロトコルが指定 https されていない場合は と見なされます。 代わりに atlas.setDomain 関数を使用することをお勧めします。

domain?: string

プロパティ値

string

enableAccessibility

アクセシビリティ機能を有効にして、Web アプリケーションの視覚化が困難なユーザーにスクリーン リーダーのサポートを提供します。 このプロパティは既定で true に設定されています。

enableAccessibility?: boolean

プロパティ値

boolean

enableAccessibilityLocationFallback

ベクター データからの場所の抽出に失敗した場合に場所のアクセシビリティを検出するために、REST API ジオコーダーへのフォールバックを有効にします。 このオプションを無効にすると、ジオコーディング API 要求が生成されなくなりますが、スクリーン リーダーの位置情報が不足する可能性があります。 default: true

enableAccessibilityLocationFallback?: boolean

プロパティ値

boolean

fadeDuration

ラベルの衝突に対するフェードイン/フェードアウト アニメーションの継続時間をミリ秒単位で制御します。 この設定は、すべてのシンボル レイヤーに影響します。 この設定は、ランタイム スタイル切り替えまたはラスター タイルのクロスフェードの期間には影響しません。

fadeDuration?: number

プロパティ値

number

localIdeographFontFamily

'CJK Unified Ideographs'、'ひらがな'、'Katakana'、および 'Hangul Syllables' の範囲でグリフの生成をローカルでオーバーライドするための CSS フォント ファミリを定義します。 これらの範囲では、フォントの太さキーワード (淡色/標準/中/太字) を除き、マップのスタイルのフォント設定は無視されます。 これらのグリフ範囲に対してマップのスタイルからフォント設定を有効にするには、false に設定します。 このオプションの目的は、帯域幅を集中的に消費するグリフ サーバー要求を回避することです。

localIdeographFontFamily?: string

プロパティ値

string

mapConfiguration

マップ構成では、マップで使用できるスタイルのセットを定義します。

mapConfiguration?: string | MapConfiguration

プロパティ値

string | MapConfiguration

maxParallelImageRequests

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

maxParallelImageRequests?: number

プロパティ値

number

refreshExpiredTiles

ベクター タイルとラスター タイルが期限切れになったときに再読み込みする必要があるかどうかを指定するブール値 (expires ヘッダーに基づく)。 これは、頻繁に更新されるデータ セットに役立ちます。 false に設定すると、各タイルは 1 回読み込まれ、必要な場合は読み込まれ、有効期限が切れると再読み込みされません。 default: true

refreshExpiredTiles?: boolean

プロパティ値

boolean

sessionId

要求と共に渡すセッション ID。 代わりに atlas.setSessionId を使用することをお勧めします。

sessionId?: string

プロパティ値

string

styleAPIVersion

スタイルとスタイルセットを要求するときに使用されるスタイル API バージョン

styleAPIVersion?: string

プロパティ値

string

styleDefinitionsVersion

styleDefinitionsPath からスタイルを要求するときに要求するスタイル定義バージョン。

styleDefinitionsVersion?: string

プロパティ値

string

subscriptionKey

要求の承認に使用される顧客サブスクリプション キー。 このオプションは、マップを初期化する場合にのみ設定できます。 代わりに atlas.setSubscriptionKey 関数を使用することをお勧めします

subscriptionKey?: string

プロパティ値

string

transformRequest

定義された transformRequest が呼び出され、タイルを読み込むためのカスタム要求パラメーターが提供されます。

transformRequest?: (url: string, resourceType: ResourceType) => RequestParameters

プロパティ値

(url: string, resourceType: ResourceType) => RequestParameters

validateStyle

True を設定すると、適用される前にスタイルが検証されます。 初期読み込み中にスタイルを処理するには、検証にかなりの時間 (数百ミリ秒) かかります。

validateStyle?: boolean

プロパティ値

boolean

workerCount

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

workerCount?: number

プロパティ値

number