API Docs for: 1.0.0
Show:

Site3dConfiguratorSettingsList Class

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

Constructor

Site3dConfiguratorSettingsList

(
  • owner
  • name
  • options
)

Parameters:

  • owner Site3dConfiguratorSettings

    Объект настроек конфигуратора или его элемента

  • name String

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

  • options String

    Значения параметров настройки

Methods

setInitValues

()

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

setInitValue

() async

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

getValueData

() Object

Метод возвращает данные для элемента списка

Returns:

Object:

Объект данных

getValueDataById

() Object

Метод возвращает данные для элемента списка по ID

Returns:

Object:

Объект данных

setValueData

(
  • Значение
  • Данные
)

Метод изменяет данные элемента списка

Parameters:

  • Значение Any

    списка

  • Данные Object

    элемента списка

setMaxValue

(
  • value
  • isEnabled
)

Метод устанавливает активность элемента настройки

Parameters:

  • value Object

    Значение элемента настройки

  • isEnabled Boolean

    Активность

addOptions

()

Метод устанавливает индивидуальные для дочерних классов параметры настройки (для переопределения)

getDomElements

(
  • domElement
)
HTMLElement[]

Метод возвращает элементы DOM настройки

Parameters:

Returns:

HTMLElement[]:

Результат

getContent

() Promise async

Метод возвращает полное содержимое настройки в виде HTML

Returns:

Promise:

Содержимое настройки

getContentInside

() Promise async

Метод возвращает внутреннее содержимое настройки в виде HTML (для переопределения)

Returns:

Promise:

Содержимое настройки

getContentInsideAdditional

() Promise async

Метод возвращает дополнительное внутреннее содержимое настройки в виде HTML (для переопределения)

Returns:

Promise:

Содержимое настройки

init

(
  • container
  • options
)

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

Parameters:

  • container HTMLElement

    HTML-контейнер

  • options Object

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

initContent

()

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

updateContent

(
  • value
)

Метод обновляет содержимое настройки в виде HTML

Parameters:

  • value String

    Значение настройки

updateContentValue

(
  • value
)

Метод обновляет значение содержимого настройки в виде HTML (для переопределения)

Parameters:

  • value Object

    Значение настройки

run

(
  • options
)
async

Метод исполняет функционал настройки

Parameters:

  • options Object

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

update

() async

Метод обновляет отображение значения настройки и исполняет её функционал

setValue

(
  • value
  • options
)
async

Метод устанавливает значение настройки и исполняет её функционал

Parameters:

  • value Any

    Значение настройки

  • options Object

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

runChangeInit

(
  • value
  • options
)
async

Метод исполняет первоначальный функционал настройки

Parameters:

  • value Any

    Значение настройки

  • options Object

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

onChange

(
  • value
  • options
)
async

Метод обработки события изменения значения настройки пользователем

Parameters:

  • value String | object

    Значение настройки

  • options Object

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

setValuePrevSilent

()

Метод устанавливает предыдущее значение настройки без запуска функционала

getFormatCaption

(
  • valueData
)
String

Метод возвращает отформатированное название настройки

Parameters:

  • valueData Object

    Данные настройки

Returns:

String:

Объект данных

getFormatValue

(
  • value
  • options
)
Any

Метод возвращает отформатированное значение настройки

Parameters:

  • value String | object

    Значение настройки

  • options Object

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

Returns:

Any:

Результат

getPresentValue

(
  • options
)
String

Метод возвращает значение настройки для презентации

Parameters:

  • options Object

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

Returns:

String:

Результат

getSaveValue

() Any

Метод возвращает значение настройки для сохранения

Returns:

Any:

Результат

enable

()

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

disable

()

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

updateEnabled

(
  • container
)

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

Parameters:

clearContent

()

Метод очистки содержимого настройки

getCurrentPrice

() Number

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

Returns:

Number:

Результат

getTotalPrice

() Number

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

Returns:

Number:

Результат

Properties

values

Any

Свойство возвращает возможные значения настройки

index

Number

Свойство возвращает индекс начального значения настройки

width

String

Свойство возвращает ширину поля настройки

view

String

Свойство возвращает вид настройки

selectMode

String

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

owner

Site3dConfiguratorSettings

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

configurator

Site3dConfigurator

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

model

Site3dModel

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

name

String

Свойство возвращает имя настройки

options

Object

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

type

String

Свойство возвращает тип настройки

valueType

String

Свойство возвращает тип значения настройки

caption

String

Свойство возвращает заголовок настройки

group

String

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

panels

String[]

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

sort

Number

Свойство возвращает порядковый номер настройки

value

Any

Свойство возвращает значение настройки

unit

String

Свойство возвращает единицы измерения настройки ('mm', 'cm', 'm', 'deg', 'piece')

part

String

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

price

Number

Свойство возвращает стоимость настройки

isVisible

Boolean

Свойство возвращает видимость настройки

isEnabled

Boolean

Свойство возвращает активность настройки

isAutoStart

Boolean

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

isSaved

Boolean

Свойство возвращает сохраняемость настройки

isExported

Boolean

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

isNeedUpdate

Boolean

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

isShowLoading

Boolean

Свойство возвращает истину, если необходимо показать экран загрузки при изменении настройки

isAutoCreate

Boolean

Свойство возвращает истину, если настройка может создаваться автоматически

updateEvent

String

Свойство возвращает название события редактирования настройки

updateValue

Function

Свойство возвращает функцию, вызываемую после изменения значения настройки

prepare

Function

Свойство возвращает обработчик предварительной подготовки настройки

change

Function

Свойство возвращает обработчик редактирования настройки

changeInit

Function

Свойство возвращает изначальный обработчик редактирования настройки

valuePrev

Any

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

unitData

Object

Свойство возвращает информацию о единице измерения настройки

unitShortcut

String

Свойство возвращает короткое название единицы измерения настройки

domElement

HTMLElement | null

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

isChanged

Boolean

Свойство возвращает истину, если настройка уже была запущена

isOnChange

Boolean

Свойство возвращает истину, если настройка была запущена через интерфейс пользователя

isLoaded

Boolean

Свойство возвращает истину, если настройка в настоящий момент показывается пользователю