Описание метода

Для настройки формата факта используется метод set_measure_format:

def set_measure_format(self, measure_names: list[str], measure_formats: list[dict],
                           set_to_default: bool = False) -> dict:

В методе используются следующие аргументы:

АргументОписание
measure_names: (list[str])Список с именами фактов в формате строки.
measure_formats: (list[dict])Список словарей с настройками формата для каждого факта.
set_to_default: (bool)

Параметр для применения стандартных настроек формата. По умолчанию имеет значение False. При установке значения True применяются стандартные настройки формата.

Если параметр set_to_default = True, то measure_formats не учитывается, необходимо передать measure_formats=[].

Словарь в составе measure_formats содержит следующие параметры, ни один из которых не является обязательным:

                            {"precision": <value>,
                             "delim": <value>,
                             "prefix": <value>,
                             "suffix": <value>,
                             "split": <value>,
                             "measureUnit": <value>,
                             "color": <value>}
КлючОписание
precision (int)Точность факта (количество знаков после разделителя). Может принимать значения от 0 до 9.
delim (str)Разделитель целой и дробной части. Допустимы точка, запятая, пробел.
prefix (str)Префикс перед значением факта, добавляет указанное значение перед значением факта, например, «₽ <значение факта>».
suffix (str)Суффикс после значения факта, добавляет указанное значение после значения факта, например, «<значение факта> руб.».
split (bool)Определяет, требуется ли разделять значения факта на группы разрядов. При значении параметра True факт будет представлен как 100 000 000, а при значении False — как 100000000.
measureUnit (str)

Разрядность отображения факта (тысячи, миллионы, миллиарды). Если этот параметр применен, то значение факта при этом автоматически пересчитывается, чтобы удовлетворять выбранной разрядности (так, 5 000 000 будет отображаться как «5» при выборе группы разрядов «Миллионы»). Также выбранная группа разрядов отображается после названия факта в мультисфере (например, «Заявка млн»). 

Допустимые значения: "", "thousand", "million", "billion", в соответствии с которыми значение факта будет отображаться в исходном виде, в тысячах, миллионах или миллиардах.

color (str)Цвет текста для значений факта в формате «#RRGGBB».

Пример использования measure formats:

[
                            {"precision": 2,
                             "delim": ",",
                             "prefix": "a",
                             "suffix": "@@@",
                             "split": True,
                             "measureUnit": "thousand",
                             "color": "#FF0000"},
                            {"precision": 3,
                             "delim": "."}
                        ]

Стандартные настройки формата:

                        {"precision": 2,
                         "delim": ".",
                         "prefix": "",
                         "suffix": "",
                         "split": True,
                         "measureUnit": "",
                         "color": "#141414"}

Пример использования метода set_measure_format:

session.set_measure_format(measure_names=["Сумма", "Количество товара"],
                           measure_formats=[{"precision": 3, "suffix": "q", "color": "#FF0000"},
                                           {"prefix": "мин", "color": "#FFFFFF"}])
или
session.set_measure_format(measure_names=["Сумма"],
                           measure_formats=[],
                           set_to_default=True)

В результате использования метода возвращается ответ от сервера, соответствующий запросу «user_iface, state: save_settings».

Пример ответа:

{'state': 1,
 'queries': [{'uuid': 'efe76be3-1a8b60e0-64904684-4c42cb8c',
   'command': {'plm_type_code': 207, 'state': 16}}]}