API Docs for: 1.0.0
Show:

Site3dConfiguratorSettings Class

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

Constructor

Site3dConfiguratorSettings

(
  • configurator
)

Parameters:

Methods

addGroup

(
  • name
  • options
)

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

Parameters:

  • name String

    Имя группы

  • options Object

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

addItem

(
  • name
  • options
)

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

Parameters:

  • name String

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

  • options Object

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

editItem

(
  • name
  • options
)

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

Parameters:

  • name String

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

  • options Object

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

addItem

(
  • name
)

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

Parameters:

  • name String

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

hasGroup

(
  • name
)
Boolean

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

Parameters:

  • name String

    Имя группы

Returns:

Boolean:

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

group

(
  • name
)
Site3dConfiguratorSettingsGroup

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

Parameters:

  • name String

    Имя группы

Returns:

Site3dConfiguratorSettingsGroup:

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

item

(
  • name
)
Site3dConfiguratorSettingsItem

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

Parameters:

  • name String

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

Returns:

Site3dConfiguratorSettingsItem:

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

toObject

(
  • checkFunc
  • fields
)
Object

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

Parameters:

  • checkFunc Function

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

  • fields Array

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

Returns:

Object:

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

Properties

configurator

Site3dConfigurator

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

groups

Map

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

options

Map

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

items

Map

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