Документация для разработчиков
Темная тема

Базовый класс таймлайна

Описание и методы

Базовый класс элемента таймлайна.

BX.UI.Timeline.Item
Метод Описание С версии
constructor(data: {}) Конструктор.

Параметры:

params - имеет следующую структуру:

  • id - идентификатор элемента (строка или число);
  • action - строковый идентификатор типа действия. На основе этого идентификатора выбирается один из наследников. Может принимать одно из значений:
    • item_create - создание элемента;
    • stage_change - смена стадии;
    • fields_change - изменение полей элемента;
    • comment - комментарий.
  • itemClassName - имя javascript-класса наследника;
  • title - заголовок записи;
  • description - содержимое записи;
  • htmlDescription - содержимое записи в html;
  • textDescription - содержимое записи в виде текста;
  • createdTimestamp - timestamp добавления записи;
  • userId - идентификатор пользователя, действие которого создало запись;
  • isFixed - true, если запись должна быть в разделе прикрепленных элементов;
  • data - список с данными о связанных сущностях:
    • item - данные об элементе до применения изменений
      • name - название элемента.
    • stageFrom - данные о стадии до изменения:
      • id - идентификатор стадии;
      • name - название стадии.
    • stageTo - данные о стадии после изменения (если она менялась);
    • task - данные о задании, в процессе выполнения которого была создана запись:
      • id - идентификатор задания;
      • title - заголовок задания;
      • description - текст задания.
    • fields - массив полей, которые были измены при создании записи:
      • title - название поля.
    • scope - идентификатор области, через которую было сделано изменение. Может принимать одно из следующих значений:
      • manual - вручную;
      • automation - роботом;
      • task - при выполнении задания;
      • rest - через приложение.
    • events - список с обработчиками событий, они формируются на стороне списка.
afterRender()Метод вызывается после рендеринга элемента.
setIsLast(isLast: boolean): ItemМетод устанавливает признак того, что элемент является последним в списке.
getContainer(): ?ElementМетод возвращает контейнер с элементом, если он отрисован.
isRendered(): booleanМетод вернет true, если элемент отрисован.
getCreatedTime(): ?DateМетод вернет дату создания записи.
formatTime(time): stringМетод вернет строку с отформатированным временем создания без даты.

Геттеры и Сеттеры

  • getId(): string|number
  • getTitle(): ?string
  • getUserId(): number
  • getScope(): ?string
  • isScopeManual(): boolean
  • isScopeAutomation(): boolean
  • isScopeTask(): boolean
  • isScopeRest(): boolean
  • getItem(): ?{name: ?string}
  • render(): Element - Метод отрисует объект и вернет контейнер.
  • updateLayout() - Метод полностью перерисует контент.
  • clearLayout(isSkipContainer = false): Item - Метод очистит содержимое контейнера и удалит из документа. Если передать true, то сам контейнер тоже будет очищен и удален.
  • getDataForUpdate(): {} - Метод вернет данные, которые нужны для обновления элемента.
  • updateData(params: {}) - Метод обновит данные элемента.
  • update(params: {}): Item - Метод обновит данные элемента и перерисует его содержимое.
  • hasMenu(): boolean - Вернет true, если у элемента есть меню.
  • getActions(): Array - Метод вернет массив пунктов для выпадающего меню.
  • renderActionsButton(): Element - Метод отрисует кнопку для выпадающего меню.
  • getActionsButton(): ?Element - Метод вернет кнопку для выпадающего меню, если она была отрисована.
  • getActionsMenuId(): string - Метод вернет идентификатор для выпадающего меню.
  • getActionsMenu(): Menu - Метод вернет меню элемента.
  • startProgress() - Метод покажет лоадер и сохранит состояние обработки ajax-запроса.
  • stopProgress() - Метод скроет лоадер и сбросит состояние обработки ajax-запроса.
  • getLoader() - Метод вернет объект BX.Loader.


© «Битрикс», 2001-2024, «1С-Битрикс», 2024