API Docs for:
Show:

Site3dConfiguratorHistory Class

Класс истории действий над конфигуратором

Constructor

Site3dConfiguratorHistory

()

Methods

clear

()

Метод очищает историю действий

startAddItem

(
  • index
  • caption
  • cancel
  • [data]
)

Метод начинает добавление действия

Parameters:

  • index String

    Идентификатор действия

  • caption String

    Название действия

  • cancel Function

    Функция отмены действия

  • [data] Site3dConfiguratorTempData optional

    Данные для обработки функциями отмены и совершения действия

stopAddItem

()

Метод останавливает добавление действия

setData

(
  • data
)

Метод устанавливает данные для обработки функциями отмены и совершения действия

Parameters:

  • data Site3dConfiguratorTempData

    Дополнительные данные

endAddItem

(
  • make
  • [additionalData]
  • [options]
)
async

Метод заканчивает добавление действия и запускает его

Parameters:

  • make Function

    Функция совершения действия

  • [additionalData] Site3dConfiguratorTempData optional

    Дополнительные данные для обработки функциями отмены и совершения действия

  • [options] Site3dConfiguratorHistoryAddItemOptions optional

    Дополнительные параметры

    • isAutoStart - истина, если make исполняется (по умолчанию истина)

addItem

(
  • index
  • caption
  • cancel
  • make
  • data
  • [options]
)
async

Метод добавляет информацию о действии и запускает его

Parameters:

  • index String

    Идентификатор действия

  • caption String

    Название действия

  • cancel Function

    Функция отмены действия

  • make Function

    Функция совершения действия

  • data Site3dConfiguratorTempData

    Данные для обработки функциями отмены и совершения действия

  • [options] Site3dConfiguratorHistoryAddItemOptions optional

    Дополнительные параметры:

    • isAutoStart - истина, если make исполняется (по умолчанию истина)

prev

()

Метод отменяет текущее в истории действие

next

()

Метод повторяет следующее в истории действие

Properties

currentIndex

String

Свойство возвращает идентификатор текущего элемента

isLastPrev

Boolean

Свойство возвращает истину, если нет предыдущих действий

isLastNext

Boolean

Свойство возвращает истину, если нет последующих действий

tempData

Site3dConfiguratorTempData | undefined

Свойство возвращает временные данные, сохраненные при начале добавление действия