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

Материал из SmartPlayer
Новая страница: «Currency Rates Widget Instruction Manual»
 
Новая страница: «== '''Widget Description''' == This widget is a functionality that allows displaying real-time information. The widget operates as a ticker with customizable parameters. == '''Adding Widget to Personal Account''' == To add this widget to your personal account, you need to request the widget from the technical support team. It will be provided as a ".zip" archive. File:Виджет_котировок.png|thumb|center| Example of widget as ".zip" archive|800...»
 
Строка 1: Строка 1:
<div lang="ru" dir="ltr" class="mw-content-ltr">
== '''Widget Description''' ==
== '''Описание виджета''' ==
This widget is a functionality that allows displaying real-time information. The widget operates as a ticker with customizable parameters.
Данный виджет является функциональностью, которая позволяет в режиме реального времени выводить информацию. Виджет работает в формате бегущей строки с настраиваемыми параметрами.
== '''Adding Widget to Personal Account''' ==
== '''Добавление виджета в личный кабинет''' ==
To add this widget to your personal account, you need to request the widget from the technical support team. It will be provided as a ".zip" archive.
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки виджет. Он будет предоставлен в формате ".zip" -архива.
[[File:Виджет_котировок.png|thumb|center| Example of widget as ".zip" archive|800px]]
[[File:Виджет_котировок.png|thumb|center| Пример виджета в формате ".zip" -архива|800px]]
After receiving it, log in to your personal account and navigate to the "Content" section.
После пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Example of "Content" section in personal account|800px]]
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела «Контент» в личном кабинете |800px]]
In the "Content" section, drag and drop the widget from local storage to the "Content" area. After transferring, the widget will appear in the content list.
В разделе «Контент» необходимо перетащить данный виджет из локального хранилища в раздел «Контент». После того как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
[[File:Перенос_виджета rss.png|thumb|center| Example of widget transfer via drag-n-drop|800px]]
[[File:Перенос_виджета rss.png|thumb|center| Пример отображения переноса виджета с помощью drag-n-drop|800px]]
{{Note|If the personal account contains much content, use the sorting function and select "Widget" content type. This functionality allows viewing all widgets added to the personal account.
{{Note|Если у пользователя много различного контента в личном кабинете, то можно использовать функцию сортировки и выбрать нужный тип контента - «Виджет». Воспользовавшись данной функциональностью, пользователь сможет просмотреть все добавленные в личный кабинет виджеты.
[[File:Вилдет_в_лк.png|thumb|center| Example of proper sorting for easier widget search|800px]]|warn}}
[[File:Вилдет_в_лк.png|thumb|center| Пример отображения правильной сортировки для более удобного поиска виджета |800px]]|warn}}
== '''Data Retrieval for Widget''' ==
== '''Получение данных для виджета''' ==
The widget sends API requests to obtain prices. It receives two price types:
Виджет отправляет запросы на получение цен по API. Виджет получает два вида цен:
* Last trade prices for instruments;
* Цены последних сделок по инструментам;
* Trading session closing prices for instruments.
* Цены закрытия торговой сессии по инструментам.
After receiving the response, the widget processes these prices for quotes and displays quote changes based on the data.<br>
Получая ответ, виджет обрабатывает эти цены для котировок и на основе полученных данных отображает изменения котировок.<br>
The widget then sends another API request containing these parameters:
Далее виджет отправляет еще один запрос по APi, который включает в себя следующие параметры:
* Instrument relation (currency, stock, precious metals) to currency;
* Отношение инструмента (валюта, акция, драгоценные металлы) к валюте;
* Icons for instrument display;
* Иконки для отображения инструмента;
Upon receiving the response, the widget transforms the information and displays it on the device.
При получении ответа виджет преобразует информацию и выводит на устройство.
{{Note|The widget's API operation uses a token that can be specified in widget settings.|warn}}
{{Note|Работа виджета через API осуществляется с помощью токена, который можно указать в настройках виджета.|warn}}
== '''Widget Configuration''' ==
== '''Настройка виджета''' ==
Locate the widget in your personal account and double-click it to access the widget's main page.
Пользователю необходимо найти свой виджет в личном кабинете и дважды кликнуть по нему. Таким образом, будет осуществлен переход на главную страницу виджета.
[[File:Главная_страницавиджета.png|thumb|center| Example of widget's main page display|800px]]
[[File:Главная_страницавиджета.png|thumb|center| Пример отображения главной страницы виджета |800px]]
Click the gear-shaped settings icon to access widget settings.
Для перехода в настройки виджета пользователю необходимо кликнуть по иконке настроек, отображаемой в виде шестеренки.
[[File:Главная_страницавиджета.png|thumb|center| Example of settings icon display|800px]]
[[File:Главная_страницавиджета.png|thumb|center| Пример отображения иконки настроек |800px]]
The settings page contains three configuration types:
Далее пользователю откроется страница с настройками виджета. На этой странице пользователю доступны три вида настроек виджета:
1. Basic settings - control widget operation;
# Основные настройки — отвечают за процесс работы виджета;
2. Quote settings - manage quote display in the widget;
# Настройки котировок — отвечают за вывод и отображение котировок в самом виджете;
3. Debugging - handles information display parameters on the device.
# Отладка — отвечает за параметры отображения информации на устройстве.  
Below is the parameter list for each settings group.
Ниже будет представлен список параметров для каждой группы настроек.
=== '''Basic Settings''' ===
=== '''Основные настройки''' ===
Parameter list in "Basic Settings" section:
Список параметров в разделе «Основные настройки»:
* Widget background - select background color for the ticker (use HEX code [reference](https://colorscheme.ru/html-colors.html));
* Фон виджета — выбирают фон, который будет использоваться для бегущей строки. Цвет можно указать с помощью HEX -кода [https://colorscheme.ru/html-colors.html можно узнать в сети];
* Cache storage time - set cache storage duration in minutes;
* Время хранения кеша — прописывается время хранения кеша в минутах;
* Video placeholder - select video content to use as placeholder.
* Видео-заглушка — выбрать видеоконтент, который будет использоваться в качестве заглушки.
[[File:Основные_настройки.png|thumb|center| Example of "Basic Settings" display|800px]]
[[File:Основные_настройки.png|thumb|center| Пример отображения настроек из раздела «Основные настройки»|800px]]
=== '''Quotes Settings''' ===
=== '''Настройки котировок''' ===
Parameter list in "Quotes Settings" section:
Список параметров в разделе «Настройки котировок»:
* Token - specify API connection token;
* Токен — указывается токен для подключения по API;
* Request frequency - set request frequency in seconds;
* Частота запроса — указывается частота запроса в секундах;
* Add quote - opens modal window for quote creation:
* Добавить котировку — открывает модальное окно в настройках позволяющее создать котировку:
  ** Quote name - specify name for quote configuration;
** Название котировки — указывается название для настройки котировок;
  ** Instrument ID - enter instrument ID received via API;
** Идентификатор инструмента — указывается идентификатор инструмента, полученный по API;
  ** Lot to RUB ratio - specify number of lots per ruble.
** Количество лотов к рублю — указывается количество лотов к рублю.
[[File:Настройки_котировок.png|thumb|center| Example of "Quotes Settings" display|800px]]
[[File:Настройки_котировок.png|thumb|center| Пример отображения настроек из раздела «Настройки котировок»|800px]]
=== '''Debugging''' ===
=== '''Отладка''' ===
Parameter list in "Debugging" section:
Список параметров в разделе «Отладка»:
* Widget width in pixels - set widget width;
* Ширина виджета в пикселях — указывается ширина виджета в пикселях;
* Screen segment height - specify segment height in pixels;
* Высота одного сегмента экрана — указывается высота сегмента экрана в пикселях;
* Segment width (segments 1-8) - set segment width in pixels;
* Ширина сегмента (сегменты от 1 до 8) — указывается ширина сегмента экрана в пикселях;
* X-axis segment offset (segments 1-8) - specify horizontal offset in pixels.
* Относительное смещение сегмента (от 1 до 8) относительно оси X — указывается смещение сегментов относительно оси Х в пикселях.
[[File:Настройки_отладка.png|thumb|center| Example of "Debugging" settings display|800px]]
[[File:Настройки_отладка.png|thumb|center| Пример отображения настроек из раздела «Отладка»|800px]]
== '''Completing Widget Setup''' ==
== '''Завершение настройки виджета''' ==
{{Note|After completing widget configuration, click "Apply Settings" in bottom right corner.
{{Note|После завершения работ по настройки виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.
[[File:Применение_настрок.png|thumb|center| Example of "Apply Settings" button|800px]]
[[File:Применение_настрок.png|thumb|center| Пример отображения кнопки «Применить настройки»|800px]]
The widget will expand to full screen - then click "Save" at bottom center.
Далее виджет растянется на весь экран и пользователю должен нажать на кнопку «Сохранить», внизу по центру экрана.
[[File:Сохран.png|thumb|center| Example of "Save" button display|800px]]|warn}}
[[File:Сохран.png|thumb|center| Пример отображения кнопки «Сохранить»|800px]]|warn}}
== '''Loading/Downloading Settings''' ==
== '''Загрузка и скачивание настроек''' ==
While configuring the widget, users can upload/download settings. These actions are available via separate icons in widget interface (bottom center).
В процессе взаимодействия с настройками виджета пользователь может загрузить и выгрузить настройки виджета. Каждое из указанных действий можно сделать по отдельным иконкам в интерфейсе виджета. Иконки расположены в виджете снизу по центру.
[[File:Иконки_загрузки.png|thumb|center| Example of settings upload/download icons|800px]]
[[File:Иконки_загрузки.png|thumb|center| Пример отображения иконок загрузить и выгрузить настройки виджета |800px]]
== '''Adding Configured Widget to Broadcast''' ==
== '''Добавление настроенного виджета в трансляцию''' ==
To fully explore this functionality, users need to launch a scheduled broadcast and add this widget as content. For steps on creating broadcasts and schedules, refer to these Wikipedia articles:
Чтобы полностью ознакомиться с работой данной функциональности пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wikipedia:
* [[Раздел "Устройства"]]
* [[Раздел "Устройства"]]
* [[Раздел "Контент на устройства"]]
* [[Раздел "Контент на устройства"]]
* [[Раздел "Трансляции"]]
* [[Раздел "Трансляции"]]
* [[Раздел "Расписание"]]
* [[Раздел "Расписание"]]
== '''Видеоинструкция''' ==
== '''Video Tutorial''' ==
[https://vk.com/video-227547238_456239059 Виджет котировки валют]
[https://vk.com/video-227547238_456239059 Currency Quotes Widget]
== '''Дополнительная информация''' ==
== '''Additional Information''' ==
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе «Обсуждения» вверху страницы.
If this article doesn't help or questions remain, please post them in the "Discussions" section at the top of the page.
[[File:Обсуждение_котировки_валю.png|thumb|center| Пример отображения вкладки «Обсуждения» на wiki-странице |800px]]
[[File:Обсуждение_котировки_валю.png|thumb|center| Example of "Discussions" tab on wiki-page|800px]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
More information available at [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
</div>

Текущая версия от 10:41, 7 мая 2025

Widget Description

This widget is a functionality that allows displaying real-time information. The widget operates as a ticker with customizable parameters.

Adding Widget to Personal Account

To add this widget to your personal account, you need to request the widget from the technical support team. It will be provided as a ".zip" archive.

Example of widget as ".zip" archive

After receiving it, log in to your personal account and navigate to the "Content" section.

Example of "Content" section in personal account

In the "Content" section, drag and drop the widget from local storage to the "Content" area. After transferring, the widget will appear in the content list.

Example of widget transfer via drag-n-drop
If the personal account contains much content, use the sorting function and select "Widget" content type. This functionality allows viewing all widgets added to the personal account.
Example of proper sorting for easier widget search

Data Retrieval for Widget

The widget sends API requests to obtain prices. It receives two price types:

  • Last trade prices for instruments;
  • Trading session closing prices for instruments.

After receiving the response, the widget processes these prices for quotes and displays quote changes based on the data.
The widget then sends another API request containing these parameters:

  • Instrument relation (currency, stock, precious metals) to currency;
  • Icons for instrument display;

Upon receiving the response, the widget transforms the information and displays it on the device.

The widget's API operation uses a token that can be specified in widget settings.

Widget Configuration

Locate the widget in your personal account and double-click it to access the widget's main page.

Example of widget's main page display

Click the gear-shaped settings icon to access widget settings.

Example of settings icon display

The settings page contains three configuration types: 1. Basic settings - control widget operation; 2. Quote settings - manage quote display in the widget; 3. Debugging - handles information display parameters on the device. Below is the parameter list for each settings group.

Basic Settings

Parameter list in "Basic Settings" section:

  • Widget background - select background color for the ticker (use HEX code [reference](https://colorscheme.ru/html-colors.html));
  • Cache storage time - set cache storage duration in minutes;
  • Video placeholder - select video content to use as placeholder.
Example of "Basic Settings" display

Quotes Settings

Parameter list in "Quotes Settings" section:

  • Token - specify API connection token;
  • Request frequency - set request frequency in seconds;
  • Add quote - opens modal window for quote creation:
 ** Quote name - specify name for quote configuration;
 ** Instrument ID - enter instrument ID received via API;
 ** Lot to RUB ratio - specify number of lots per ruble.
Example of "Quotes Settings" display

Debugging

Parameter list in "Debugging" section:

  • Widget width in pixels - set widget width;
  • Screen segment height - specify segment height in pixels;
  • Segment width (segments 1-8) - set segment width in pixels;
  • X-axis segment offset (segments 1-8) - specify horizontal offset in pixels.
Example of "Debugging" settings display

Completing Widget Setup

After completing widget configuration, click "Apply Settings" in bottom right corner.
Example of "Apply Settings" button

The widget will expand to full screen - then click "Save" at bottom center.

Example of "Save" button display

Loading/Downloading Settings

While configuring the widget, users can upload/download settings. These actions are available via separate icons in widget interface (bottom center).

Example of settings upload/download icons

Adding Configured Widget to Broadcast

To fully explore this functionality, users need to launch a scheduled broadcast and add this widget as content. For steps on creating broadcasts and schedules, refer to these Wikipedia articles:

Video Tutorial

Currency Quotes Widget

Additional Information

If this article doesn't help or questions remain, please post them in the "Discussions" section at the top of the page.

Example of "Discussions" tab on wiki-page

More information available at Как взаимодействовать пользователю с разделом "Обсуждения"