Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

GetColumnSpecAsJson

Возвращает спецификацию столбцов модели в формате JSON.

Спецификация столбца — это описание столбца модели данных: его идентификатор, заголовок, описание, единицы измерения, тип данных и модификаторы доступа. Набор полей соответствует параметрам функции AddColumn, с помощью которой столбец создаётся.

string GetColumnSpecAsJson()

Параметры

Отсутствуют.

Возвращаемое значение

Тип – string.

JSON-объект с полем columns — массивом описаний всех столбцов модели. Для каждого столбца указываются:

Поле Описание
name Идентификатор столбца.
displayName Заголовок столбца.
description Описание столбца.
units Единицы измерения значения в столбце.
typeCode Тип данных значения в столбце.
isReadOnly Модификатор доступа «только чтение».
maybeEmpty Разрешение/запрет ячейкам в столбце не содержать значений.

Пример возвращаемого значения:

{
  "columns": [
    {
      "name": "value",
      "displayName": "Значение",
      "description": "Значение сигнала",
      "units": "",
      "typeCode": "variant",
      "isReadOnly": false,
      "maybeEmpty": false
    },
    {
      "name": "quality",
      "displayName": "Качество",
      "description": "Качество сигнала",
      "units": "",
      "typeCode": "uint4",
      "isReadOnly": false,
      "maybeEmpty": false
    },
    {
      "name": "timestamp",
      "displayName": "Метка времени",
      "description": "Метка времени сигнала",
      "units": "",
      "typeCode": "timestamp",
      "isReadOnly": false,
      "maybeEmpty": false
    },
    {
      "name": "server_timestamp",
      "displayName": "Метка времени сервера",
      "description": "Метка времени регистрации сигнала",
      "units": "",
      "typeCode": "timestamp",
      "isReadOnly": false,
      "maybeEmpty": true
    }
  ]
}