你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ServiceOptions interface
所有 atlas 服务请求中使用的全局属性。
- Extends
属性
| auth |
用于自定义映射控件如何通过Azure Maps服务进行身份验证的身份验证选项。 如果指定了这些身份验证选项，则 ServiceOptions.subscriptionKey 不应为 。 建议改用 atlas.setAuthenticationOptions 函数。 |
| disable |
禁用遥测收集 此选项只能在初始化映射时设置。 默认值：Azure 政府云) 的 false (true |
| domain | 请求地图磁贴和其他Azure Maps服务时要使用的域。
如果未指定 |
| enable |
启用辅助功能，为难以可视化 Web 应用程序的用户提供屏幕阅读器支持。 默认情况下，此属性设置为 true。 |
| enable |
启用对 REST API 地理编码器的回退，以便在从矢量数据提取位置失败时检测位置可访问性。 禁用此选项将阻止生成地理编码 API 请求，但可能会导致屏幕阅读器缺少位置信息。 默认值：true |
| fade |
控制标签冲突的淡入/淡出动画持续时间（以毫秒为单位）。 此设置会影响所有符号层。 此设置不会影响运行时样式转换或光栅图块交叉消退的持续时间。 |
| local |
定义 CSS 字体系列，用于在“CJK 统一象形字”、“平假名”、“片假名”和“朝鲜文音节”范围内本地替代生成字形。 在这些区域中，将忽略地图样式中的字体设置，但字体粗细关键字 (浅/常规/中/粗体) 除外。 设置为 false，以启用这些字形范围的地图样式中的字体设置。 此选项的目的是避免带宽密集型字形服务器请求。 |
| map |
地图配置定义可用于地图的样式集。 |
| max |
(光栅图块、子画面、图标) 并行加载的最大图像数，这会影响重光栅地图的性能。 默认情况下为 16。 |
| refresh |
一个布尔值，指定在矢量和光栅图块过期时是否应根据标头) 过期 (重新加载。 这对于频繁更新的数据集很有用。 如果设置为 false，则每个磁贴将在需要时加载一次，并且不会在过期时重新加载。 default： true |
| session |
要随请求一起传递的会话 ID。 建议改用 atlas.setSessionId。 |
| style |
请求样式和样式集时使用的样式 API 版本 |
| style |
从 styleDefinitionsPath 请求样式时要请求的样式定义版本。 |
| subscription |
用于授权请求的客户订阅密钥。 只能在初始化映射时设置此选项。 建议改用 atlas.setSubscriptionKey 函数 |
| transform |
如果定义了 transformRequest，则将调用 以提供用于加载磁贴的自定义请求参数。 |
| validate |
如果为 True，请在应用样式之前对其进行验证。 在初始加载期间，验证需要花费 (几百毫秒) 时间来处理样式。 |
| worker |
在页面上实例化的 Web 辅助角色数。 默认情况下，它设置为 CPU 核心数的一半， (上限为 6) 。 |
属性详细信息
authOptions
用于自定义映射控件如何通过Azure Maps服务进行身份验证的身份验证选项。 如果指定了这些身份验证选项，则 ServiceOptions.subscriptionKey 不应为 。 建议改用 atlas.setAuthenticationOptions 函数。
authOptions?: AuthenticationOptions属性值
disableTelemetry
禁用遥测收集 此选项只能在初始化映射时设置。 默认值：Azure 政府云) 的 false (true
disableTelemetry?: boolean属性值
boolean
domain
请求地图磁贴和其他Azure Maps服务时要使用的域。
如果未指定 https 协议，则假定为 。
建议改用 atlas.setDomain 函数。
domain?: string属性值
string
enableAccessibility
启用辅助功能，为难以可视化 Web 应用程序的用户提供屏幕阅读器支持。 默认情况下，此属性设置为 true。
enableAccessibility?: boolean属性值
boolean
enableAccessibilityLocationFallback
启用对 REST API 地理编码器的回退，以便在从矢量数据提取位置失败时检测位置可访问性。 禁用此选项将阻止生成地理编码 API 请求，但可能会导致屏幕阅读器缺少位置信息。 默认值：true
enableAccessibilityLocationFallback?: boolean属性值
boolean
fadeDuration
控制标签冲突的淡入/淡出动画持续时间（以毫秒为单位）。 此设置会影响所有符号层。 此设置不会影响运行时样式转换或光栅图块交叉消退的持续时间。
fadeDuration?: number属性值
number
localIdeographFontFamily
定义 CSS 字体系列，用于在“CJK 统一象形字”、“平假名”、“片假名”和“朝鲜文音节”范围内本地替代生成字形。 在这些区域中，将忽略地图样式中的字体设置，但字体粗细关键字 (浅/常规/中/粗体) 除外。 设置为 false，以启用这些字形范围的地图样式中的字体设置。 此选项的目的是避免带宽密集型字形服务器请求。
localIdeographFontFamily?: string属性值
string
mapConfiguration
maxParallelImageRequests
(光栅图块、子画面、图标) 并行加载的最大图像数，这会影响重光栅地图的性能。 默认情况下为 16。
maxParallelImageRequests?: number属性值
number
refreshExpiredTiles
一个布尔值，指定在矢量和光栅图块过期时是否应根据标头) 过期 (重新加载。 这对于频繁更新的数据集很有用。 如果设置为 false，则每个磁贴将在需要时加载一次，并且不会在过期时重新加载。 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