Dictionary.getParameters

Синтаксис

getParameters();

Описание

Метод getParameters возвращает массив параметров справочника НСИ в формате метаданных.

Комментарии

Метод возвращает массив JSON-объектов со следующими полями: id - идентификатор параметра. k - его ключ, n - наименование, predefined - идентификатор предопределённого параметра, к которому относится данный параметр, vis - признак отображения параметра.

Пример

Для выполнения примера необходимо наличие на странице компонента DictionaryBox с наименованием «dictionaryBox» (см. «Пример создания компонента DictionaryBox» ). Определим параметры справочника НСИ, доступные для отображения:

// Получим справочник НСИ
var source = dictionaryBox.getSource()[0];
// Получим параметры справочника
var parameters = source.getParameters();
if (source.hasVisibleParams()) {
    console.log("Параметры справочника:");
    for (var i = 0; i < parameters.length; i++) {
        console.log("Идентификатор параметра: %s, наименование: ", parameters[i].id, parameters[i].n);
    };
} else {
    console.log("Справочник не содержит доступных для отображения параметров");
};

В результате выполнения примера в консоли браузера были выведены идентификаторы и наименования параметров справочников НСИ, доступных для отображения:

Параметры справочника:

Идентификатор параметра: CURDATE, наименование:  Дата актуальности
 

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

См. также:

Dictionary