Инструкция по работе с виджетом котировок валют

Описание виджета

Данный виджет является функциональностью, которая позволяет в режиме реального времени выводить информацию. Виджет работает в формате бегущей строки с настраиваемыми параметрами.

Добавление виджета в личный кабинет

Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки виджет. Он будет предоставлен в формате ".zip" -архива.

Пример виджета в формате ".zip" -архива

После пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».

Пример отображения раздела «Контент» в личном кабинете

В разделе «Контент» необходимо перетащить данный виджет из локального хранилища в раздел «Контент». После того как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.

Пример отображения переноса виджета с помощью drag-n-drop

Если у пользователя много различного контента в личном кабинете, то можно использовать функцию сортировки и выбрать нужный тип контента - «Виджет». Воспользовавшись данной функциональностью, пользователь сможет просмотреть все добавленные в личный кабинет виджеты.

Пример отображения правильной сортировки для более удобного поиска виджета

Получение данных для виджета

Виджет отправляет запросы на получение цен по API. Виджет получает два вида цен:

• Цены последних сделок по инструментам;
• Цены закрытия торговой сессии по инструментам.

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

• Отношение инструмента (валюта, акция, драгоценные металлы) к валюте;
• Иконки для отображения инструмента;

При получении ответа виджет преобразует информацию и выводит на устройство.

Работа виджета через API осуществляется с помощью токена, который можно указать в настройках виджета.

Настройка виджета

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

Пример отображения главной страницы виджета

Для перехода в настройки виджета пользователю необходимо кликнуть по иконке настроек, отображаемой в виде шестеренки.

Пример отображения иконки настроек

Далее пользователю откроется страница с настройками виджета. На этой странице пользователю доступны три вида настроек виджета:

1. Основные настройки — отвечают за процесс работы виджета;
2. Настройки котировок — отвечают за вывод и отображение котировок в самом виджете;
3. Отладка — отвечает за параметры отображения информации на устройстве.

Ниже будет представлен список параметров для каждой группы настроек.

Основные настройки

Список параметров в разделе «Основные настройки»:

• Фон виджета — выбирают фон, который будет использоваться для бегущей строки. Цвет можно указать с помощью HEX -кода можно узнать в сети;
• Время хранения кеша — прописывается время хранения кеша в минутах;
• Видео-заглушка — выбрать видеоконтент, который будет использоваться в качестве заглушки.

Пример отображения настроек из раздела «Основные настройки»

Настройки котировок

Список параметров в разделе «Настройки котировок»:

• Токен — указывается токен для подключения по API;
• Частота запроса — указывается частота запроса в секундах;
• Добавить котировку — открывает модальное окно в настройках позволяющее создать котировку:
  • Название котировки — указывается название для настройки котировок;
  • Идентификатор инструмента — указывается идентификатор инструмента, полученный по API;
  • Количество лотов к рублю — указывается количество лотов к рублю.

Пример отображения настроек из раздела «Настройки котировок»

Отладка

Список параметров в разделе «Отладка»:

• Ширина виджета в пикселях — указывается ширина виджета в пикселях;
• Высота одного сегмента экрана — указывается высота сегмента экрана в пикселях;
• Ширина сегмента (сегменты от 1 до 8) — указывается ширина сегмента экрана в пикселях;
• Относительное смещение сегмента (от 1 до 8) относительно оси X — указывается смещение сегментов относительно оси Х в пикселях.

Пример отображения настроек из раздела «Отладка»

Завершение настройки виджета

После завершения работ по настройки виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.

Пример отображения кнопки «Применить настройки»

Далее виджет растянется на весь экран и пользователю должен нажать на кнопку «Сохранить», внизу по центру экрана.

Пример отображения кнопки «Сохранить»

Загрузка и скачивание настроек

В процессе взаимодействия с настройками виджета пользователь может загрузить и выгрузить настройки виджета. Каждое из указанных действий можно сделать по отдельным иконкам в интерфейсе виджета. Иконки расположены в виджете снизу по центру.

Пример отображения иконок загрузить и выгрузить настройки виджета

Добавление настроенного виджета в трансляцию

Чтобы полностью ознакомиться с работой данной функциональности пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wikipedia:

• Раздел "Устройства"
• Раздел "Контент на устройства"
• Раздел "Трансляции"
• Раздел "Расписание"

Видеоинструкция

Виджет котировки валют

Дополнительная информация

Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе «Обсуждения» вверху страницы.

Пример отображения вкладки «Обсуждения» на wiki-странице

Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"