Skip to main content

URL 参数

可以向 ArcGIS StoryMaps 项目的 URL 添加参数，以修改其行为或激活特定功能。 必须按照以下约定将这些参数添加至 ArcGIS StoryMaps URL：

[baseURL] + ? + [parameter1] + & + [parameter2] + & + [parameter3] + & + ...

基础 URL

基础 URL 是 ArcGIS StoryMaps 用来访问资源和功能的服务器端点。 支持参数的三个基础 URL 如下所示。

操作 基础 URL
创建新项目 https://storymaps.arcgis.com/[storymap-type]/new
编辑项目（构建器） https://storymaps.arcgis.com/[storymap-type]/[storymap-itemID]/edit
查看项目（查看器） https://storymaps.arcgis.com/[storymap-type]/[storymap-itemID]

注:

  • [storymap-type] 可以是 stories、briefings、frames、collections、templates 或 themes。

  • [storymap-itemID] 可能是类型为 StoryMap 或 StoryMap theme 的 ArcGIS 项目的 ID。

  • 目前没有办法查看主题。

重要信息：

在 ArcGIS Enterprise 中，将 storymaps.arcgis.com 替换为 [your-portal-domain]/[web-adaptor-name]/apps/storymaps/。

例如：

https://www.myorg.gov/my-portal/apps/storymaps/[storymap-type]/new

显示参数

显示参数与基础 URL 一起用于查看 ArcGIS StoryMaps 项目：

https://storymaps.arcgis.com/[storymap-type]/[storymap-itemID]
参数 行为
值		 故事 简报 框 集合
play 激活自动播放 true（默认）
false		 ✅ ✅ ❌ ✅
speed 控制自动播放速度（需要 play=true） slow
medium（默认）
fast		 ✅ ✅ ❌ ✅
header 查看项目时显示/隐藏页眉 true（默认）
false		 ✅ ✅ ❌ ✅
cover 展示/隐藏封面 true（默认）
false		 ✅ ✅ ✅ ✅
navigation 显示/隐藏导航控件 true（默认）
false		 ❌ ❌ ❌ ✅
item 按数字位置显示集合项目 1、2、3、... ❌ ❌ ❌ ✅

注:

  • 如果未指定参数值，将使用默认值。 例如，play 与 play=true 相同。

  • header和 cover URL 参数会覆盖当前配置的项目行为。 例如，如果故事中已激活隐藏封面，cover=true 可用于显示封面。 有关详细信息，请参阅配置故事设置。

  • 当故事嵌入在 <iframe> 中时，将隐藏页眉，但 header 参数可用于强制显示该页眉。 嵌入简报或集合的页眉默认不会隐藏，因为它包含导航元素。 有关详细信息，请参阅标准嵌入。

  • 隐藏简报的页眉会导致其导航工具栏不可用。 读者仍可使用键盘或幻灯片远程附件进行导航。 无法隐藏集合的页眉。

显示参数示例

以下示例结合了基础 URL 和参数，展示了如何为一些典型用例构建有效 URL。

操作
URL
为简报启用慢速自动播放 .../briefings/[itemID]?play&speed=slow
隐藏简报页眉 .../briefings/[storymap-itemID]?header=false
隐藏故事的页眉和封面 .../stories/[storymap-itemID]?header=false&cover=false
隐藏页眉，但显示故事封面 .../stories/[storymap-itemID]?header=false&cover=true
显示集合中的第五个项目 .../collections/[storymap-itemID]?item=5

项目创建参数

项目创建参数与基础 URL 一起用于创建新 ArcGIS StoryMaps 项目：

https://storymaps.arcgis.com/[storymap-type]/new
参数		 行为
值		 故事 简报 框 集合
theme 创建新 ArcGIS StoryMaps 项目，并应用主题 [theme-itemID] ✅ ✅ ❌ ✅
webmap 创建新 ArcGIS StoryMaps 故事，并将 Web 地图添加为第一个块 [webmap-itemID] ✅ ❌ ❌ ❌
webscene 创建新 ArcGIS StoryMaps 故事，并将 Web 场景添加为第一个块 [webscene-itemID] ✅ ❌ ❌ ❌
template 基于模板创建新 ArcGIS StoryMaps 故事 [template-itemID] ✅ ❌ ❌ ❌

项目创建示例

以下示例结合了基础 URL 和项目创建参数，展示了如何为几个典型用例构建有效 URL。

操作
URL
创建新简报并应用主题 .../briefings/new?theme=[theme-itemID]
创建新故事并将 Web 地图添加为第一个块 .../stories/new?webmap=[webmap-itemID]

登录参数

以下参数适用于所有项目类型。

参数		 行为
值
urlKey 引导用户访问特定组织的登录页面 - 例如，如果组织使用企业登录。 您的 ArcGIS 组织简称，即组织 URL 的第一部分。 请参阅以下示例。

登录参数示例

操作
URL
引导读者登录 https://myorg.maps.arcgis.com .../briefings/[storymap-itemID]?urlKey=myorg
提示：

有关使用 urlKey 参数的详细信息，请参阅通过特定组织链接共享故事地图。

变量参数 (Beta)

Beta：

变量参数处于测试阶段。 如果您在测试版功能遇到问题，请在 Esri 社区分享您的反馈。

变量参数仅在使用 ArcGIS Online 时生效，且仅适用于故事。 变量参数可能会受到突破性更改，因此不建议用于高规格的生产部署。

变量参数允许您将信息传递给 ArcGIS StoryMaps 项目 URL，然后在嵌入内容的 URL 中引用。

参数		 行为
值
var_[variable_name] 定义名为 variable_name 的变量，可以在嵌入 URL 中引用 用户提供的值
重要信息：

变量参数名必须只包含字母和数字，必须使用前缀 var_ 命名，并且区分大小写。 包含空格或其他特殊字符的变量值必须进行编码。

变量参数可用于支持 URL 参数的嵌入式 ArcGIS 应用程序，如 ArcGIS Dashboards、ArcGIS Survey123、ArcGIS Experience Builder 和 ArcGIS Instant Apps。 您也可以在嵌入其他非 ArcGIS 应用程序或网站时使用变量参数。

抢先版本：

想了解各种 ArcGIS 应用程序中的 URL 参数如何工作以及如何使用这些参数，请参见下面的链接。

变量参数示例

以下示例展示了如何在典型用例中构建有效的 URL。 第一个 URL 展示了如何在嵌入 URL 中引用变量参数，第二个 URL 展示了如何在 ArcGIS StoryMaps 项目 URL 中传递变量的值。

本示例使用名为 mercury 的变量将值 0.25 传递给仪表盘预配置的数值参数（名为 mercuryMin）。 参数过滤仪表盘中的信息，仅显示高于最低水质检测结果的位置。

仪表盘 URL（添加到带有嵌入块的故事中）：

https://www.arcgis.com/apps/dashboards/[dashboard-itemID]#mercuryMin={{$custom.mercury}}

ArcGIS StoryMaps 项目 URL：

https://storymaps.arcgis.com/stories/[storymap-itemID]?var_mercury=0.25

其他资源