Инструкция по работе с виджетом котировок валют
Описание виджета
Данный виджет является функциональностью, которая позволяет в режиме реального времени выводить информацию. Виджет работает в формате бегущей строки с настраиваемыми параметрами. Виджет предназначен для операционных систем: Windows и Ubuntu Linux.
Добавление виджета в личный кабинет
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки виджет. Он будет предоставлен в формате ".zip" -архива.
После пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».
В разделе «Контент» необходимо перетащить данный виджет из локального хранилища в раздел «Контент». После того как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
Получение данных для виджета
Виджет отправляет запросы на получение цен по API. Виджет получает два вида цен:
- Цены последних сделок по инструментам;
- Цены закрытия торговой сессии по инструментам.
Получая ответ, виджет обрабатывает эти цены для котировок и на основе полученных данных отображает изменения котировок.
Далее виджет отправляет еще один запрос по APi, который включает в себя следующие параметры:
- Отношение инструмента (валюта, акция, драгоценные металлы) к валюте;
- Иконки для отображения инструмента;
При получении ответа виджет преобразует информацию и выводит на устройство.
Настройка виджета
Пользователю необходимо найти свой виджет в личном кабинете и дважды кликнуть по нему. Таким образом, будет осуществлен переход на главную страницу виджета.
Для перехода в настройки виджета пользователю необходимо кликнуть по иконке настроек, отображаемой в виде шестеренки.
Далее пользователю откроется страница с настройками виджета. На этой странице пользователю доступны три вида настроек виджета:
- Основные настройки — отвечают за процесс работы виджета;
- Настройки котировок — отвечают за вывод и отображение котировок в самом виджете;
- Отладка — отвечает за параметры отображения информации на устройстве.
Ниже будет представлен список параметров для каждой группы настроек.
Основные настройки
Список параметров в разделе «Основные настройки»:
- Фон виджета — выбирают фон, который будет использоваться для бегущей строки. Цвет можно указать с помощью HEX -кода можно узнать в сети;
- Время хранения кеша — прописывается время хранения кеша в минутах. Используется в ситуациях, когда виджет не получает данные и берёт их из кеша;
- Видео-заглушка — выбрать видеоконтент, который будет использоваться в качестве заглушки при отсутствии данных и завершения отображения данных из кеша.
Настройки котировок
Список параметров в разделе «Настройки котировок»:
- Токен — указывается токен для подключения по API;
- Частота запроса — указывается частота запроса в секундах;
- Добавить котировку — открывает модальное окно в настройках позволяющее создать котировку:
- Иконка «Скрыть котировку» — позволяет убрать отображение котировки при проигрывании виджета в трансляции. Отображается иконкой в виде глаза;
- Иконка «Удалить котировку» — позволяет удалить котировку из виджета. Отображается иконкой в виде мусорной корзины
- Название котировки — указывается название для настройки котировок;
- Идентификатор инструмента — указывается идентификатор инструмента, полученный по API;
- Количество лотов к рублю — указывается количество лотов к рублю.
Отладка
Список параметров в разделе «Отладка»:
- Ширина виджета в пикселях — указывается ширина виджета в пикселях;
- Высота одного сегмента экрана — указывается высота сегмента экрана в пикселях;
- Ширина сегмента (сегменты от 1 до 8) — указывается ширина сегмента экрана в пикселях;
- Относительное смещение сегмента (от 1 до 8) относительно оси X — указывается смещение сегментов относительно оси Х в пикселях.
Завершение настройки виджета
Далее виджет растянется на весь экран и пользователю должен нажать на кнопку «Сохранить», внизу по центру экрана.
Загрузка и скачивание настроек
В процессе взаимодействия с настройками виджета пользователь может загрузить и выгрузить настройки виджета. Каждое из указанных действий можно сделать по отдельным иконкам в интерфейсе виджета. Иконки расположены в виджете снизу по центру.
Ограничения
В данном виджете присутствуют следующие ограничения:
- Виджет может работать максимум на 8 экранах.
Добавление настроенного виджета в трансляцию
Чтобы полностью ознакомиться с работой данной функциональности пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wikipedia:
Видеоинструкция
Дополнительная информация
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе «Обсуждения» вверху страницы.
Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"
