Описание параметров
Имя | Описание | Пример | |
|---|---|---|---|
"graph": { | модуль графики | ||
| "id" : | id типа модуля | "id" : 600 | |
"graph_type" | тип графика | "graph_type" : 634 | |
"scatter": uint32_t, | круги | 630 | |
"spheres": uint32_t, | шары | 631 | |
"cluster_scatter": uint32_t, | точечный график, бассейны (круги с кластеризацией) | 632 | |
"cluster_spheres": uint32_t, | 3D-бассейны (шары с кластеризацией) | 633 | |
"line": uint32_t, | линии, цилиндры, области, области с накоплением, цилиндры с накоплением | 634 | |
"tube_line": uint32_t, | коридоры (линии с кластеризацией) | 635 | |
"pie": uint32_t, | пироги | 636 | |
"3d": uint32_t, | поверхность | 637 | |
"radar": uint32_t, | радар | 638 | |
"dimensioned_columns": uint32_t, | не используется | 639 | |
"graph": uint32_t, | граф | 640 | |
"sankey": uint32_t, | санкей | 641 | |
"boxplot": uint32_t, | диаграмма размаха | 642 | |
"parallel": uint32_t, | параллели (линии в параллельных осях) | 643 | |
"combo_chart": uint32_t, | комбинированный график | 644 | |
"chord_diagram": uint32_t | хордовый график | 645 | |
DrillAction | углубление в данные по верхним размерностям для графиков линии, цилиндры и в кластеры для графика пироги 0 - IN погрузиться в данные на следующий уровень; 1 - OUT вернуться на уровень выше | "drill_action" : 0 | |
"in": 0, | погрузиться в данные на следующий уровень | 0 | |
"out": 1 | вернуться на уровень выше | 1 | |
| GraphSettings | настройки графики | ||
| "top_index": uint32_t , | "top_index": -1 | ||
| "max_elements": uint32_t , | "max_elements": -1 | ||
| "pie_percent": uint32_t , | размер сектора "Остальные", % от пирога | "pie_percent": 28 | |
| "rotation": RotationType | смена направления чтения данных из мультисферы (столбец/строка). Auto : 0 - по умолчанию (для разных конфигураций мультисфер); Column : 1 - чтение по столбцам; Row : 2 - чтение по строкам; None : 3 - смена направления недоступна. | "direction_type" : 2 | |
| PlmError | состояние модуля | ||
| "code": int, | код ошибки/состояния | "code": 100 | |
| "message": string | текст ошибки/состояния | "message": "No dimensions on left side" | |
| PlmGraphData | |||
| "warnings": [PlmGraphWarning], | "warnings" : [ ] | ||
| "reduced": bool, | "reduced" : false | ||
| "rotation": RotationType, | смена направления чтения данных из мультисферы (столбец/строка). Auto - по умолчанию (для разных конфигураций мультисфер); Column - чтение по столбцам; Row - чтение по строкам; None - смена направления недоступна | "rotation" : 3 | |
| "facts_info": [FactDesc], | перечислены все отмеченные/видимые факты, участвующие в построении графика | "facts_info" : [{ "id" : "b3aa65f7", "name" : "Номер", "level" : 1, "visible" : true, "selected" : false, "horizontal" : false, "olap3_type" : 1, "plm_type" : 0, "base_id" : "00000000", "fgroup_id" : "00000000" }] | |
| "dimension_info": [DimensionDesc], | размерности, участвующие в построении графика | "dimension_info" : [{ "id" : "7e281cf5", "name" : "Дата месяц", "olap_type" : 11, "olap3_type" : 1, "module_id" : 0, "position" : 1, "level" : 0, "uniq_count" : 8, "haveFilter" : false, "base_id" : "00000000", "real_uniq_count" : 5 }] | |
| "zoom" : ZoomState | состояние зума (детализация) | "zoom" : { "current" : [ 0, 4 ], "range" : [ 0, 4 ]} | |
| "x_axe_name": string, | имя оси (для типов scatter, cluster_scatter, column_line, row_line, tube_line) | "x_axe_name" : "Дата месяц" | |
| "y_axe_name": string, | имя оси (для типов scatter, cluster_scatter, column_line, row_line, tube_line) | "y_axe_name" : "Номер" | |
| "marks": {JsonObject}, | имена для засечек на оси | "marks" : { "0" : "Май", "1" : "Июнь", "2" : "Июль", "3" : "Август"} | |
| "min": double, | минимальное значение факта для построения графика | "min" : 4.629 | |
| "max": double, | максимальное значение факта для построения графика | "max" : 4.759 | |
| "use_top_index": double | возможность переключения по верхней размерности | "use_top_index" : false | |
| ZoomState | состояние зума (детализация) | "zoom" : { "current" : [ 0, 4 ], "range" : [ 0, 4 ]} | |
| "current" : [std::array<std::size_t, 2>], | текущие границы детализации: крайние точки | "current" : [ 0, 4 ] | |
| "range" : [std::array<std::size_t, 2>] | "range" : [ 0, 4 ] | ||
Обязательные действия
- авторизоваться authenticate : login
- создать слой user_layer : create_layer
- открыть мультисферу - запросить размерности OLAP : dimension и факты OLAP : fact
- сконфигурировать мультисферу (вынести размерности, наложить фильтры и пр.)
- открыть модуль графики user_iface : create_module
Команды
Общие ошибки
Код ошибки | Текст ошибки | Описание |
|---|---|---|
| "code": RequestAuthError (270) | "message": "Only authentication command allowed" | ошибка появляется, когда пользователь не залогинился |
| "code": LayerError (308) | "message": "There is no such layer" | ошибка появляется, когда не был создан слой (или отправлен пустой layer_id), не был создан модуль графики |
| "code": LayerNotLoadedError (309) | "message": "Layer is not loaded" | ошибка появляется, когда слой не был загружен |
| "code": PermissionError (204) | "message": "Failed to get the resource with id 00000000: ( :0 )" | ошибка появляется, когда не была открыта мультисфера |
| "code": GraphError (1100) | "message": "Graph base error" | ошибка модуля графики |
| "code": GraphTooMuchDataError (1101) | "message": "Graph: too much data to build plot" | ошибка появляется, когда для построения типа графика слишком много данных |
| "code": GraphNegativeValueError (1102) | "message": "Graph: this plot couldn't be built for negative values" | ошибка появляется, если тип графика не может быть построен на отрицательных значениях |
| "code": GraphNotEnoughtDataError (1103) | "message" : "Graph: not enought data for plot" | ошибка появляется, когда для построения типа графика недостаточно данных (вынесены размерности, но значения не подходят для построения, например, все значения нулевые или отрицательные) |
| "code": GraphTooManyElementsError (1104) | "message" : "Graph: this type of chart does not support more than 500 elements." | ошибка появляется, когда тип графика не поддерживается на указанном количестве элементов |
| "code": LogicError (100) | "message" : "Graph module: initialize fail, parent is null." | ошибка появляется, когда у модуля графики нет родительского модуля (OLAP) |
| "code": RuntimeError (200) | "message" : "Graph module: initialize fail, parent is not olap module." | ошибка появляется, когда у модуля графики родительский модуль не OLAP |
| "code": RuntimeError (200) | "message" : "Graph module: initialize fail, can't cast to olap module." | ошибка появляется, когда у модуля графики родительский OLAP модуль недоступен |
| "code": LogicError (100) | "message" : "Thread number should be more than zero" | |
| "code": RuntimeError (200) | "message" : "Graphic object was busy, request for result again" | ошибка появляется при длительном ожидании ответа (TimeoutException) |
| "code": RequestInvalidError (261) | "message" : "Graphic module command handle fail." | ошибка появляется, когда отправленная команда не описана на сервере |