Skip to main content

Параметры URL

Параметры могут быть добавлены к URL элемента ArcGIS StoryMaps для изменения его поведения или активации определенных функций. Они должны быть добавлены в URL ArcGIS StoryMaps с использованием следующего соглашения:

[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] может быть ID элемента ArcGIS типа StoryMap или StoryMap theme.

  • В настоящее время нет возможности просмотреть тему.

Важно:

В 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.

  • Параметры URL header и cover переопределяют текущее настроенное поведение элемента. Например, если в истории активировано Скрыть обложку, 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 и добавить веб-карту в качестве первого блока [webmap-itemID]
webscene Создать новую историю ArcGIS StoryMaps и добавить веб-сцену в качестве первого блока [webscene-itemID]
template Создать новую историю ArcGIS StoryMaps по шаблону [template-itemID]

Примеры создания элементов

Приведенные ниже примеры объединяют базовый URL и параметры создания элементов, чтобы показать, как создать допустимый URL для нескольких типичных сценариев использования.

Действие
URL
Создать новый брифинг и применить тему .../briefings/new?theme=[theme-itemID]
Создайте новую историю с веб-картой в качестве первого блока .../stories/new?webmap=[webmap-itemID]

Параметры входа

Приведённый ниже параметр работает со всеми типами элементов.

Параметр
Поведение
Значения
urlKey Направьте пользователя на страницу входа в систему для конкретной организации – например, если организация использует корпоративные учетные записи. Краткое имя вашей организации ArcGIS, которое является первой частью URL вашей организации. См. пример ниже.

Пример параметра входа

Действие
URL
Направить читателей для входа по адресу https://myorg.maps.arcgis.com .../briefings/[storymap-itemID]?urlKey=myorg
Подсказка:

Для получения дополнительной информации об использовании параметра urlKey см. раздел Публикация StoryMap со ссылкой, специфичной для организации.

Переменные параметры (бета)

Бета-версия:

Переменные параметры находятся в бета-версии. Если вы столкнулись с проблемами при использовании бета-функциональности, поделитесь информацией в Сообществе Esri.

Переменные параметры работают только при использовании ArcGIS Online и только с историями. Переменные параметры могут получать критические изменения, поэтому их не рекомендуется использовать в масштабных производственных развертываниях.

Переменные параметры позволяют передавать информацию на URL элемента ArcGIS StoryMaps, который затем доступен для ссылки в URL встроенного ресурса.

Параметр
Поведение
Значения
var_[variable_name] Определяет переменную с именем variable_name, на которую можно ссылаться в встраиваемых URL Пользовательские значения
Важно:

Имена переменных параметров должны содержать только буквы и цифры, называться с помощью префикса var_, а также они учитывают регистр. Значения переменных, содержащие пробелы или другие специальные символы, должны быть закодированы.

Переменные параметры можно использовать с встроенными приложениями ArcGIS, поддерживающими параметры URL, такими как ArcGIS Dashboards, ArcGIS Survey123, ArcGIS Experience Builder и ArcGIS Instant Apps. Вы также можете использовать переменные параметры при внедрении других приложений или веб-сайтов, отличных от ArcGIS.

[! DIVEIN] Чтобы узнать, как работают параметры URL в различных приложениях ArcGIS и что с ними можно сделать, смотрите ссылки ниже.

Примеры параметров переменных

Пример ниже иллюстрирует, как построить допустимые URL для типичного сценария использования. Первый URL показывает, как ссылаться на переменный параметр во встраиваемом URL, а второй — как передать значение переменной в URL элемента ArcGIS StoryMaps.

В этом примере используется переменная с именем mercury для передачи значения 0.25 в заранее настроенный числовой параметр операционной панели под названием mercuryMin. Параметр фильтрует информацию на операционной панели, показывая только места, которые превышают минимальный результат тестирования качества воды.

URL операционной панели (добавлен в историю с блоком встраивания):

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

URL элемента ArcGIS StoryMaps:

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

Дополнительные ресурсы