1
0
mirror of https://github.com/salexdv/bsl_console.git synced 2024-11-24 08:33:29 +02:00

Описание универсального объекта ТабличнаяЧасть #266

This commit is contained in:
salexdv 2022-01-23 08:51:57 +03:00
parent a60d33a888
commit 0a2785318b

View File

@ -35883,6 +35883,259 @@ define([], function () {
"ЯчейкиМакетаЗаголовкаКоллекцииЗначенийОбластиКомпоновкиДанных": {},
"ЯчейкиМакетаКоллекцииЗначенийОбластиКомпоновкиДанных": {},
"ЯчейкиТаблицыОбластиКомпоновкиДанных": {}
},
"universalObjects": {
"ТабличнаяЧасть": {
"name": "ТабличнаяЧасть",
"name_en": "TabularSection",
"description": "Универсальный объект для хранения наборов однородной информации, принадлежащих объекту (справочнику, документу, отчету или обработке) и не используемых самостоятельно",
"methods": {
"Вставить": {
"name": "Вставить",
"name_en": "Insert",
"description": "Вставляет в табличную часть строку с указанным индексом. Использование метода допустимо только в том случае, если табличная часть получена из свойства объекта. Если табличная часть получена из свойства ссылки (или выборки), то использование этого метода будет вызывать ошибку выполнения.",
"returns": "Тип: СтрокаТабличнойЧасти. Вставленная строка.",
"signature": {
"default": {
"СтрокаПараметров": "(Индекс: Число): СтрокаТабличнойЧасти",
"Параметры": {
"Индекс": "Индекс вставляемой строки."
}
}
}
},
"Выгрузить": {
"name": "Выгрузить",
"name_en": "Unload",
"description": "Создает таблицу значений и копирует в нее табличную часть. Имена колонок таблицы значений совпадают с именами колонок табличного поля. Колонка, содержащая номер строки, выгружается в колонку с именем НомерСтроки.",
"returns": "Тип: ТаблицаЗначений",
"ref": "classes.ТаблицаЗначений",
"signature": {
"default": {
"СтрокаПараметров": "(Строки?, Колонки?): ТаблицаЗначений",
"Параметры": {
"Строки": "Массив строк табличной части для выгрузки. Если не указан, выгружаются все строки табличной части",
"Колонки": "Строка, Список колонок для копирования в формате: 'Колонка1, Колонка2...'. Если список не задан, то будут скопированы все колонки."
}
},
"ПоОтбору": {
"СтрокаПараметров": "(ПараметрыОтбора?, Колонки?): ТаблицаЗначений",
"Параметры": {
"Строки": "Структура, ключ структуры - идентификатор колонки, а значение структуры - значение отбора",
"Колонки": "Строка, Список колонок для копирования в формате: 'Колонка1, Колонка2...'"
}
}
}
},
"ВыгрузитьКолонки": {
"name": "ВыгрузитьКолонки",
"name_en": "UnloadColumns",
"description": "Создает таблицу значений с заданным списком колонок. Выгружается только структура табличной части, данные не выгружаются.",
"returns": "Тип: ТаблицаЗначений. ",
"ref": "classes.ТаблицаЗначений",
"signature": {
"default": {
"СтрокаПараметров": "(Колонки): ТаблицаЗначений",
"Параметры": {
"Колонка": "Строка, Список колонок для выгрузки в формате: 'Колонка1, Колонка2...'. Если список не задан, то будут выгружены все колонки."
}
}
}
},
"ВыгрузитьКолонку": {
"name": "ВыгрузитьКолонку",
"name_en": "UnloadColumn",
"description": "Создает массив и копирует в него значения, содержащиеся в колонке табличной части.",
"returns": "Тип: Массив. ",
"ref": "classes.Массив",
"signature": {
"default": {
"СтрокаПараметров": "(Колонка: Число): Массив",
"Параметры": {
"Колонка": "Колонка, значения которой необходимо выгрузить. В качестве значения параметра может выступать индекс колонки, имя колонки, сама колонка."
}
}
}
},
"Добавить": {
"name": "Добавить",
"name_en": "Add",
"description": "Добавляет строку в конец табличной части. Использование метода допустимо только в том случае, если табличная часть получена из свойства объекта. Если табличная часть получена из свойства ссылки (или выборки), то использование этого метода будет вызывать ошибку выполнения.",
"returns": "Тип: СтрокаТабличнойЧасти"
},
"Загрузить": {
"name": "Загрузить",
"name_en": "Load",
"description": "Загружает табличную часть из таблицы значений. При этом все прежние строки табличной части удаляются. При загрузке значения в колонках табличной части заполняются значениями из колонок таблицы значений с совпадающими именами. Использование метода допустимо только в том случае, если табличная часть получена из свойства объекта. Если табличная часть получена из свойства ссылки (или выборки), то использование этого метода будет вызывать ошибку выполнения.",
"signature": {
"default": {
"СтрокаПараметров": "(Таблица)",
"Параметры": {
"Таблица": "Таблица значений, откуда загружается табличная часть. Колонки таблиц совмещаются по именам."
}
}
}
},
"ЗагрузитьКолонку": {
"name": "ЗагрузитьКолонку",
"name_en": "LoadColumn",
"description": "Загружает колонку табличной части из массива значений. Использование метода допустимо только в том случае, если табличная часть получена из свойства объекта. Если табличная часть получена из свойства ссылки (или выборки), то использование этого метода будет вызывать ошибку выполнения.",
"signature": {
"default": {
"СтрокаПараметров": "(Массив: Массив, Колонка: Число)",
"Параметры": {
"Массив": "Массив значений, который выступает в качестве источника данных для колонки.",
"Колонка": "Колонка, в которую будут загружены значения из массива. В качестве значения параметра может выступать индекс колонки, имя колонки, сама колонка."
}
}
}
},
"Индекс": {
"name": "Индекс",
"name_en": "IndexOf",
"description": "Получает индекс строки в коллекции строк табличной части.",
"returns": "Тип: Число. Индекс указанной строки в коллекции. Если не найдено, то возвращается -1.",
"signature": {
"default": {
"СтрокаПараметров": "(Строка: СтрокаТабличнойЧасти): Число",
"Параметры": {
"Строка": "Строка табличной части, для которой нужно определить индекс."
}
}
}
},
"Итог": {
"name": "Итог",
"name_en": "Total",
"description": "Суммирует значения всех строк в указанной колонке.",
"returns": "Тип: Число, Неопределено. Сумма значений по всем строкам указанной колонки.",
"signature": {
"default": {
"СтрокаПараметров": "(Колонка: Строка): Число",
"Параметры": {
"Колонка": "Имя колонки, по которой необходимо посчитать итог."
}
}
}
},
"Количество": {
"name": "Количество",
"name_en": "Count",
"description": "Получает количество строк табличной части.",
"returns": "Тип: Число. "
},
"Найти": {
"name": "Найти",
"name_en": "Find",
"description": "Осуществляет поиск значения в указанных колонках табличной части.",
"returns": "Тип: СтрокаТабличнойЧасти, Неопределено. Строка, в которой содержится искомое значение. Если значение не найдено, то возвращается значение Неопределено.",
"signature": {
"default": {
"СтрокаПараметров": "(Значение: Произвольный, Колонки?: Строка): СтрокаТабличнойЧасти",
"Параметры": {
"Значение": "Искомое значение.",
"Колонки": "Список имен колонок, разделенных запятыми, по которым производится поиск. Если параметр не указан, поиск осуществляется по всей табличной части. Значение по умолчанию: Пустая строка."
}
}
}
},
"НайтиСтроки": {
"name": "НайтиСтроки",
"name_en": "FindRows",
"description": "Осуществляет поиск строк табличной части, соответствующих заданному условию поиска.",
"returns": "Тип: Массив. Массив из строк табличной части, соответствующих заданному условию поиска. Замечание! Массив хранит ссылки на строки табличной части, то есть при изменении строки в табличной части, значение в массиве тоже будет изменено.",
"ref": "classes.Массив",
"signature": {
"default": {
"СтрокаПараметров": "(ПараметрыОтбора: Структура): Массив",
"Параметры": {
"ПараметрыОтбора": "Задает условия поиска: ключ структуры определяет имя колонки, по которой будет осуществляться поиск, а значение структуры - искомое значение."
}
}
}
},
"Очистить": {
"name": "Очистить",
"name_en": "Clear",
"description": "Удаляет все строки табличной части. Использование метода допустимо только в том случае, если табличная часть получена из свойства объекта. Если табличная часть получена из свойства ссылки (или выборки), то использование этого метода будет вызывать ошибку выполнения"
},
"Получить": {
"name": "Получить",
"name_en": "Get",
"description": "Получает значение по индексу. Работает аналогично оператору [].",
"returns": "Тип: СтрокаТабличнойЧасти",
"signature": {
"default": {
"СтрокаПараметров": "(Индекс: Число): СтрокаТабличнойЧасти",
"Параметры": {
"Индекс": "Индекс строки."
}
}
}
},
"Свернуть": {
"name": "Свернуть",
"name_en": "GroupBy",
"description": "Осуществляет свертку табличной части по указанным колонкам группировки. Строки, у которых совпадают значения в колонках, указанных в первом параметре, сворачиваются в одну строку. Значения этих строк, хранящиеся в колонках, указанных во втором параметре, накапливаются. Использование метода допустимо только в том случае, если табличная часть получена из свойства объекта. Если табличная часть получена из свойства ссылки (или выборки), то использование этого метода будет вызывать ошибку выполнения.",
"signature": {
"default": {
"СтрокаПараметров": "(КолонкиГруппировок: Строка, КолонкиСуммирования?: Строка)",
"Параметры": {
"КолонкиГруппировок": "Имена колонок, разделенные запятыми, по которым необходимо группировать строки табличной части.",
"КолонкиСуммирования": "Имена колонок, разделенные запятыми, по которым необходимо суммировать значения в строках табличной части."
}
}
}
},
"Сдвинуть": {
"name": "Сдвинуть",
"name_en": "Move",
"description": "Сдвигает строку на указанное количество позиций. Использование метода допустимо только в том случае, если табличная часть получена из свойства объекта. Если табличная часть получена из свойства ссылки (или выборки), то использование этого метода будет вызывать ошибку выполнения.",
"signature": {
"default": {
"СтрокаПараметров": "(Строка: Число, Смещение: Число)",
"Параметры": {
"Строка": "Индекс строки, которую нужно переместить, или сама строка.",
"Смещение": "Количество строк, на которое необходимо переместить строку. Положительное значение означает, что строка будет передвинута ближе к концу таблицы значений (вниз), отрицательное - ближе к началу (вверх)."
}
}
}
},
"Сортировать": {
"name": "Сортировать",
"name_en": "Sort",
"description": "Сортирует табличную часть в соответствии с указанными правилами сортировки. Использование метода допустимо только в том случае, если табличная часть получена из свойства объекта. Если табличная часть получена из свойства ссылки (или выборки), то использование этого метода будет вызывать ошибку выполнения.",
"signature": {
"default": {
"СтрокаПараметров": "(Колонки: Строка, ОбъектСравнения?: СравнениеЗначений)",
"Параметры": {
"Колонки": "Список имен колонок, разделенных запятыми, по которым производится сортировка табличной части. После каждого имени колонки через пробел может быть указано направление сортировки. Направление определяется: \"Убыв\" (\"Desc\") - упорядочивать по убыванию; \"Возр\" (\"Asc\") - упорядочивать по возрастанию. По умолчанию сортировка производится по возрастанию. Порядок указания имен колонок таблицы определяет порядок сортировки. Это означает, что сначала таблица сортируется по колонке, указанной первой. Затем группы строк с одинаковым значением в этой колонке сортируются по колонке, которая указана второй, и так далее.",
"ОбъектСравнения": "Объект для сравнения значений. Независимо от того, задан объект сравнения или нет, элементы, чьи типы не совпадают, сравниваются по коду типа, а элементы простых типов сравниваются по значению. Дополнительно к этому: - если объект сравнения не задан, то элементы остальных типов сравниваются по строковому представлению; - если объект сравнения задан, то: - объекты сравниваются по идентификатору; - моменты времени сравниваются по дате и идентификатору объекта; - элементы остальных типов сравниваются по строковому представлению."
}
}
}
},
"Удалить": {
"name": "Удалить",
"name_en": "Delete",
"description": "Удаляет строку табличной части. Использование метода допустимо только в том случае, если табличная часть получена из свойства объекта. Если табличная часть получена из свойства ссылки (или выборки), то использование этого метода будет вызывать ошибку выполнения",
"signature": {
"УдалениеПоОбъекту": {
"СтрокаПараметров": "(Строка: СтрокаТабличнойЧасти)",
"Параметры": {
"Строка": "Удаляемая строка табличной части."
}
},
"УдалениеПоИндексу": {
"СтрокаПараметров": "(Индекс: Число)",
"Параметры": {
"Индекс": "Индекс строки, которую необходимо удалить."
}
}
}
}
}
}
}
}
});