Настройка отображения итогов

Общие итоги

По столбцам

Для включения/отключения совокупных итогов по столбцам в текущем OLAP-модуле используется метод set_global_horizontal_total:

set_global_horizontal_total(show: bool) -> dict:

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

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

{'state': 1,
 'queries': [{'uuid': '9e5d7f38-658ce955-0b934777-9de28341',
   'command': {'plm_type_code': 506,
    'state': 37,
    'command_id': '00000000-00000000-00000000-00000000',
    'module_id': '9e5d7f38-658ce955-0b934777-9de28341'}}]}

По строкам

Для включения/отключения совокупных итогов по строкам в текущем OLAP-модуле используется метод set_global_vertical_total:

set_global_vertical_total(show: bool) -> dict:

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

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

{'state': 1,
 'queries': [{'uuid': 'a03f2e6e-f8d894a5-e8a8ebda-5afa928d',
   'command': {'plm_type_code': 506,
    'state': 39,
    'command_id': '00000000-00000000-00000000-00000000',
    'module_id': 'a03f2e6e-f8d894a5-e8a8ebda-5afa928d'}

Метод change_total_mode (устаревший метод)

Для включения/отключения совокупных итогов и по строкам, и по столбцам в текущем OLAP-модуле используется метод change_total_mode:

change_total_mode() -> dict:

Изменение режима показа итогов в мультисфере. Если до вызова данного метода итогов в таблице не было, то они отобразятся, и наоборот.

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

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

{'state': 1,
 'queries': [{'uuid': '9e5d7f38-f774a249-1b20b0a9-035c1047',
   'command': {'plm_type_code': 506,
    'state': 28,
    'command_id': '00000000-00000000-00000000-00000000',
    'module_id': '9e5d7f38-f774a249-1b20b0a9-035c1047',
    'dimension_name': '',
    'name': '',
    'fold_select_status': False,
    'show_inter_total': False,
    'show_global_horz_total': True,
    'show_global_vert_total': True,
    'select_counter': 0,
    'script_action_group_id': 4294967295,
    'dim_id': '00000000',
    'is_total': False,
    'fact_id': '00000000',
    'sort_type': 0,
    'dim_ids': [],
    'fact_ids': []}}]}

Вместо change_total_mode рекомендуется использовать отдельные методы set_global_horizontal_total и set_global_vertical_total.

Промежуточные итоги

По всем столбцам

Для включения/отключения промежуточных итогов по столбцам в текущем OLAP-модуле используется метод set_all_inter_horizontal_total:

set_all_inter_horizontal_total(show: bool) -> dict:

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

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

{'state': 1,
 'queries': [{'uuid': '7ab52db8-c8119a06-2c1cdb85-df39f642',
   'command': {'plm_type_code': 506,
    'state': 47,
    'command_id': '00000000-00000000-00000000-00000000',
    'module_id': '7ab52db8-c8119a06-2c1cdb85-df39f642'}}]}

По всем строкам

Для включения/отключения промежуточных итогов по строкам в текущем OLAP-модуле используется метод set_all_inter_vertical_total:

set_all_inter_vertical_total(show: bool) -> dict:

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

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

{'state': 1,
 'queries': [{'uuid': '7ab52db8-c8119a06-2c1cdb85-df39f642',
   'command': {'plm_type_code': 506,
    'state': 47,
    'command_id': '00000000-00000000-00000000-00000000',
    'module_id': '7ab52db8-c8119a06-2c1cdb85-df39f642'}}]}

По конкретной размерности слева

Для включения/отключения промежуточных итогов по конкретной вынесенной влево размерности в текущем OLAP-модуле используется метод set_inter_horizontal_total:

set_inter_horizontal_total(dimension_name: str, show: bool) -> dict:

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

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

{'state': 1,
 'queries': [{'uuid': '4ffb7e3b-f296f351-b0da067e-25bf210d',
   'command': {'plm_type_code': 506,
    'state': 41,
    'command_id': '00000000-00000000-00000000-00000000',
    'module_id': '4ffb7e3b-f296f351-b0da067e-25bf210d',
    'dimension_name': 'Тип карты'}}]}

По конкретной размерности сверху

Для включения/отключения промежуточных итогов по конкретной вынесенной вверх размерности в текущем OLAP-модуле используется метод set_inter_vertical_total:

set_inter_vertical_total(dimension_name: str, show: bool) -> dict:

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

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

{'state': 1,
 'queries': [{'uuid': '7c26a5a6-c77d70dd-7140f661-1411afce',
   'command': {'plm_type_code': 506,
    'state': 41,
    'command_id': '00000000-00000000-00000000-00000000',
    'module_id': '7c26a5a6-c77d70dd-7140f661-1411afce',
    'dimension_name': 'Дата транзакции квартал'}}]}

Получение информации о режиме отображения итогов

По всем итогам

Для получения информации о режиме отображения итогов в текущем OLAP-модуле используется метода get_total_mode:

get_total_mode() -> bool:

Если отображение итогов включено, в ответе получаем True, иначе False.

Итоги по столбцам

Для получения информации о режиме отображения общего итога по столбцам в текущем OLAP-модуле используется метода get_global_horizontal_total:

get_global_horizontal_total() -> bool:

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

Если отображение итогов включено, в ответе получаем True, иначе False.

Итоги по строкам

Для получения информации о режиме отображения общего итога по строкам в текущем OLAP-модуле используется метода get_global_vertical_total:

get_global_horizontal_total() -> bool:

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

Если отображение итогов включено, в ответе получаем True, иначе False.