API Docs for:
Show:

Site3dConfiguratorSettings Class

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

Constructor

Site3dConfiguratorSettings

(
  • owner
)

Parameters:

Methods

addGroup

(
  • name
  • options
)

Метод добавляет группу настроек

Parameters:

  • name String

    Имя группы

  • options Site3dConfiguratorGroupOptions

    Параметры группы

addItem

(
  • name
  • options
)

Метод добавляет настройку

Parameters:

  • name String

    Имя настройки

  • options Site3dConfiguratorSettingsItemOptions

    Параметры настройки

editItem

(
  • name
  • options
)

Метод редактирует настройку

Parameters:

  • name String

    Имя настройки

  • options Site3dConfiguratorSettingsItemOptions

    Параметры настройки

addItem

(
  • name
)

Метод удаляет настройку

Parameters:

  • name String

    Имя настройки

hasGroup

(
  • name
)
Boolean

Метод возвращает истину, если есть группа настроек

Parameters:

  • name String

    Имя группы

Returns:

Boolean:

Наличие группы

group

(
  • name
)
Site3dConfiguratorSettingsGroup

Метод возвращает объект группы настроек

Parameters:

  • name String

    Имя группы

Returns:

Site3dConfiguratorSettingsGroup:

Объект группы настроек

hasItem

(
  • name
)
Boolean

Метод возвращает истину, если есть настройка

Parameters:

  • name String

    Имя настройки

Returns:

Boolean:

Наличие настройки

item

(
  • name
)
Site3dConfiguratorSettingsItem | undefined

Метод возвращает объект настройки

Parameters:

  • name String

    Имя настройки

Returns:

Site3dConfiguratorSettingsItem | undefined:

Объект настройки

toObject

(
  • checkFunc
  • fields
)
Object.>

Метод возвращает параметры настройки в виде объекта

Parameters:

  • checkFunc (function(Site3dConfiguratorSettingsItem): boolean) | null

    Функция фильтрации настроек

  • fields String | null

    Массив параметров для выгрузки (по умолчанию выгружаются все поля)

Returns:

Object.>:

Объект параметров настроек

setup

()

Метод устанавливает добавленные ранее настройки

init

(
  • container
)
async

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

Parameters:

  • container HTMLElement

    HTML-контейнер

Properties

owner

Site3dConfigurator | Site3dConfiguratorItem

Свойство возвращает объект конфигуратора или его элемент (кому принадлежат настройки)

configurator

Site3dConfigurator

Свойство возвращает объект конфигуратора

groups

Map

Свойство возвращает группы настроек

options

Map

Свойство возвращает коллекцию параметров настроек

items

Map

Свойство возвращает элементы настроек