metadata.js API metadata.js API

  • Документация к версии: 0.11.217

    • Программный интерфейс

    Показывать:

    Класс TabularSection

    Определен в: src\meta_tabulars.js:12
    Модуль: meta_tabulars
    Родительский модуль: metadata

    Абстрактный объект табличной части

    • Физически, данные хранятся в DataObj, а точнее - в поле типа массив и именем табчасти объекта _obj
    • Класс предоставляет методы для доступа и манипуляции данными табчасти

    Конструктор

    TabularSection

    (
    • name
    • owner
    )

    Определен в src\meta_tabulars.js:12

    Параметры:

    • name String
      • имя табчасти
    • owner DataObj
      • владелец табличной части

    Методы

    add

    (
    • attr
    )
    TabularSectionRow

    Определен в src\meta_tabulars.js:208

    Добавляет строку табчасти

    Параметры:

    • attr Object
      • объект со значениями полей. если некого поля нет в attr, для него используется пустое значение типа

    Возвращает:

    TabularSectionRow:

    Пример:

    // Добавляет строку в табчасть и заполняет её значениями, переданными в аргументе
var row = ts.add({field1: value1});

    aggregate

    (
    • [dimensions]
    • [resources]
    • [aggr]
    • [ret_array]
    )
    Number | Array

    Определен в src\meta_tabulars.js:315

    Вычисляет агрегатную функцию по табличной части

    • Не изменяет исходный объект. Если пропущен аргумент aggr - вычисляет сумму.
    • Стандартные агрегаторы: SUM, COUNT, MIN, MAX, FIRST, LAST, AVG, AGGR, ARRAY, REDUCE
    • AGGR - позволяет задать собственный агрегатор (функцию) для расчета итогов

    Параметры:

    • [dimensions] Array | String optional
      • список измерений
    • [resources] Array | String optional
      • список ресурсов
    • [aggr] String optional
      • агрегатная функция
    • [ret_array] Boolran optional
      • указывает возвращать массив значений

    Возвращает:

    Number | Array:
    • Значение агрегатной фукнции или массив значений

    Пример:

    // вычисляем сумму (итог) по полю amount табличной части
var total = ts.aggregate("", "amount");

// вычисляем максимальные суммы для всех номенклатур табличной части
// вернёт массив объектов {nom, amount}
var total = ts.aggregate("nom", "amount", "MAX", true);

    clear

    () TabularSection

    Определен в src\meta_tabulars.js:88

    Очищает табличнут часть

    Возвращает:

    TabularSection:

    Пример:

    // Очищает табличнут часть
ts.clear();

    count

    () Number

    Определен в src\meta_tabulars.js:77

    Возвращает количество элементов в табчасти

    Возвращает:

    Number:

    Пример:

    // количество элементов в табчасти
var count = ts.count();

    del

    (
    • val
    )

    Определен в src\meta_tabulars.js:113

    Удаляет строку табличной части

    Параметры:

    each

    (
    • fn
    )

    Определен в src\meta_tabulars.js:248

    Выполняет цикл "для каждого"

    Параметры:

    • fn Function
      • callback, в который передается строка табчасти

    find

    (
    • val
    • columns
    )
    TabularSectionRow

    Определен в src\meta_tabulars.js:157

    Находит первую строку, содержащую значение

    Параметры:

    • val
      • значение для поиска
    • columns String | Array
      • колонки, в которых искать

    Возвращает:

    TabularSectionRow:

    find_rows

    (
    • [selection]
    • [callback]
    )
    Array

    Определен в src\meta_tabulars.js:170

    Находит строки, соответствующие отбору

    Если отбор пустой, возвращаются все строки табчасти

    Параметры:

    • [selection] Object optional
      • в ключах имена полей, в значениях значения фильтра или объект {like: "значение"}
    • [callback] Function optional
      • в который передается строка табчасти на каждой итерации

    Возвращает:

    Array:

    forEach

    ()

    Определен в src\meta_tabulars.js:260

    Псевдоним для each

    get

    (
    • index
    )
    TabularSectionRow

    Определен в src\meta_tabulars.js:67

    Возвращает строку табчасти по индексу

    Параметры:

    • index Number
      • индекс строки табчасти

    Возвращает:

    TabularSectionRow:

    group_by

    (
    • [dimensions]
    • [resources]
    )

    Определен в src\meta_tabulars.js:267

    Сворачивает табличную часть

    детали см. в aggregate

    Параметры:

    • [dimensions] Array | String optional
    • [resources] Array | String optional

    load

    (
    • aattr
    )

    Определен в src\meta_tabulars.js:392

    Загружает табличнут часть из массива объектов

    Параметры:

    • aattr Array
      • массив объектов к загрузке

    sort

    (
    • fields
    )

    Определен в src\meta_tabulars.js:283

    Сортирует табличную часть

    Параметры:

    • fields Array | String

    swap

    (
    • rowid1
    • rowid2
    )

    Определен в src\meta_tabulars.js:190

    Меняет местами строки табчасти

    Параметры:

    sync_grid

    (
    • grid
    • [selection]
    )

    Определен в src\meta_tabulars.js:421

    Перезаполняет грид данными табчасти с учетом отбора

    Параметры:

    • grid DhtmlxGrid
      • элемент управления
    • [selection] Object optional
      • в ключах имена полей, в значениях значения фильтра или объект {like: "значение"}

    Свойства

    _name

    String

    Определен в src\meta_tabulars.js:30

    Имя табличной части

    _obj

    Object

    Определен в src\meta_tabulars.js:50

    Фактическое хранилище данных объекта

    Оно же, запись в таблице объекта локальной базы данных

    _owner

    DataObj

    Определен в src\meta_tabulars.js:40

    Объект-владелец табличной части