metadata.js API metadata.js API

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

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

    Показывать:

    Класс DataObj

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

    Абстрактный объект данных

    Прародитель как ссылочных объектов (документов и справочников), так и регистров с суррогатным ключом и несохраняемых обработок
    См. так же:

    Конструктор

    DataObj

    (
    • attr
    • manager
    )

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

    Параметры:

    • attr Object
      • объект с реквизитами в свойствах или строка guid ссылки
    • manager RefDataManager

    Методы

    _silent

    (
    • [v]
    )

    Определен в src\meta_objs.js:619

    Включает тихий режим

    Режим, при котором объект не информирует мир об изменениях своих свойств.
    Полезно, например, при групповых изменениях, чтобы следящие за объектом формы не тратили время на перерисовку при изменении каждого совйтсва

    Параметры:

    • [v] Boolean optional

    delete_attachment

    (
    • att_id
    )
    асинхронный

    Определен в src\meta_objs.js:604

    Удаляет присоединенный объект или файл

    Вызывает одноименный метод менеджера и передаёт ссылку на себя в качестве контекста

    Параметры:

    • att_id String
      • идентификатор (имя) вложения

    empty

    () Boolean

    Определен в src\meta_objs.js:373

    Проверяет, является ли ссылка объекта пустой

    Возвращает:

    Boolean:
    • true, если ссылка пустая

    form_obj

    (
    • pwnd
    • attr
    )

    Описан в модуле wnd_obj

    Определен в src\widgets\wnd_obj.js:615

    Форма объекта данных

    По умолчанию, форма строится автоматически по описанию метаданных.
    Метод можно переопределить для конкретного менеджера

    Параметры:

    • pwnd DhtmlXWindows
      • указатель на родительскую форму
    • attr Object
      • параметры инициализации формы

    get_attachment

    (
    • att_id
    )

    Определен в src\meta_objs.js:574

    Возвращает присоединенный объект или файл

    Параметры:

    • att_id String
      • идентификатор (имя) вложения

    is_new

    () Boolean

    Определен в src\meta_objs.js:323

    Возвращает "истина" для нового (еще не записанного или не прочитанного) объекта

    Возвращает:

    Boolean:

    load

    () Promise. асинхронный

    Определен в src\meta_objs.js:384

    Читает объект из внешней или внутренней датабазы асинхронно. В отличии от _mgr.get(), принудительно перезаполняет объект сохранёнными данными

    Возвращает:

    Promise.:
    • промис с результатом выполнения операции

    mark_deleted

    (
    • deleted
    )

    Определен в src\meta_objs.js:346

    Установить пометку удаления

    Параметры:

    • deleted Boolean

    print

    (
    • model
    • [wnd]
    )
    | Value асинхронный

    Определен в src\meta_objs.js:641

    Выполняет команду печати

    Вызывает одноименный метод менеджера и передаёт себя в качестве объекта печати

    Параметры:

    • model String
      • идентификатор макета печатной формы
    • [wnd] Object optional
      • указатель на форму, из которой произведён вызов команды печати

    Возвращает:

    | Value:

    |void}

    save

    (
    • [post]
    • [operational]
    • [attachments]
    )
    Promise. асинхронный

    Определен в src\meta_objs.js:454

    Записывает объект

    Ввыполняет подписки на события перед записью и после записи
    В зависимости от настроек, выполняет запись объекта во внешнюю базу данных

    Параметры:

    • [post] Boolean | Undefined optional
      • проведение или отмена проведения или просто запись
    • [operational] Boolean optional
      • режим проведения документа (Оперативный, Неоперативный)
    • [attachments] Array optional
      • массив вложений

    Возвращает:

    Promise.:
    • промис с результатом выполнения операции

    save_attachment

    (
    • att_id
    • attachment
    • [type]
    )
    асинхронный

    Определен в src\meta_objs.js:586

    Сохраняет объект или файл во вложении

    Вызывает одноименный метод менеджера и передаёт ссылку на себя в качестве контекста

    Параметры:

    • att_id String
      • идентификатор (имя) вложения
    • attachment Blob | String
      • вложениe
    • [type] String optional
      • mime тип

    Возвращает:

    Promise.

    unload

    ()

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

    Освобождает память и уничтожает объект

    Свойства

    _data

    DataManager только для чтения

    Определен в src\meta_objs.js:98

    Пользовательские данные - аналог AdditionalProperties Дополнительные cвойства в 1С

    _deleted

    Boolean

    Определен в src\meta_objs.js:300

    Пометка удаления

    _manager

    DataManager только для чтения

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

    Указатель на менеджер данного объекта

    _metadata

    Object только для чтения

    Определен в src\meta_objs.js:287

    Метаданные текущего объекта

    _obj

    Object только для чтения

    Определен в src\meta_objs.js:62

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

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

    _ts_

    Unknown

    Определен в src\meta_objs.js:74

    Хранилище ссылок на табличные части - не сохраняется в базе данных

    ref

    String

    Определен в src\meta_objs.js:360

    guid ссылки объекта