API Docs for:
Show:

Site3dConfiguratorSettingsCustom Class

Extends Site3dConfiguratorSettingsItem
Defined in: modules\configurator\configurator.js:9833
Module: Site3dConfigurator

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

Constructor

Site3dConfiguratorSettingsCustom

(
  • configurator
  • name
  • options
)

Defined in modules\configurator\configurator.js:9833

Parameters:

  • configurator Site3dConfigurator

    Объект конфигуратора

  • name String

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

  • options String

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

Methods

addOptions

()

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6016

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

getDomElements

(
  • domElement
)
HTMLElement

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6033

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

Parameters:

  • domElement HTMLElement

    DOM элемент

Returns:

HTMLElement:

Результат

getContent

() Promise async

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6049

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

Returns:

Promise:

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

getContentInside

(
  • options
)
Promise async

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6062

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

Parameters:

  • options Object

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

Returns:

Promise:

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

getContentInsideAdditional

() Promise async

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6073

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

Returns:

Promise:

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

init

(
  • domElement
  • options
)

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6087

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

Parameters:

  • domElement HTMLElement

    HTML-контейнер

  • options Object

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

initContent

(
  • domElement
  • options
)

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6117

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

Parameters:

  • domElement HTMLElement

    HTML-контейнер

  • options Object

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

updateContent

(
  • value
)

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6127

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

Parameters:

  • value String

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

updateContentValue

(
  • value
  • options
)

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6143

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

Parameters:

  • value Object

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

  • options Object

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

run

(
  • options
)
async

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6208

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

Parameters:

  • options Object

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

update

(
  • options
)
async

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6268

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

Parameters:

  • options Object

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

setValue

(
  • value
  • options
)
async

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6280

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

Parameters:

  • value Any

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

  • options Object

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

runChangeInit

(
  • value
  • options
)
async

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6298

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

Parameters:

  • value Any

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

  • options Object

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

onChange

(
  • value
  • options
)
async

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6318

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

Parameters:

  • value String | object

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

  • options Object

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

setValuePrevSilent

()

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6362

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

getFormatValue

(
  • value
  • options
)
Any

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6371

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

Parameters:

  • value String | object

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

  • options Object

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

Returns:

Any:

Результат

getPresentValue

(
  • options
)
String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6388

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

Parameters:

  • options Object

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

Returns:

String:

Результат

getSaveValue

() Any

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6399

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

Returns:

Any:

Результат

show

()

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6409

Метод показывает настройку

hide

()

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6418

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

updateVisible

(
  • container
)

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6427

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

Parameters:

  • container HTMLElement

    DOM элемент

enable

()

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6454

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

disable

()

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6463

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

updateEnabled

(
  • HTMLElement}
)

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6472

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

Parameters:

  • HTMLElement} Object

    container DOM элемент

clearContent

()

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6499

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

getCurrentLabel

(
  • value
)
String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6508

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

Parameters:

  • value Object

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

Returns:

String:

Результат

isShowCurrentLabel

() Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6519

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

Returns:

Boolean:

Результат

getCurrentPriceString

(
  • value
)
String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6529

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

Parameters:

  • value Object

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

Returns:

String:

Результат

getCurrentPrice

(
  • value
)
Number

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6540

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

Parameters:

  • value Object

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

Returns:

Number:

Результат

getTotalPrice

() Number

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6551

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

Returns:

Number:

Результат

getPresentValueData

(
  • options
)
Object

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6561

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

Parameters:

  • options Object

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

Returns:

Object:

Результат

Properties

owner

Site3dConfiguratorSettings

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5549

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

configurator

Site3dConfigurator

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5559

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

model

Site3dModel

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5569

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

name

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5579

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

options

Object

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5589

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

type

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5599

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

valueType

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5609

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

caption

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5619

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

captionInterface

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5629

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

isShowCaption

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5639

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

group

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5649

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

panels

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5659

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

sort

Number

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5669

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

display

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5679

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

value

Any

Inherited from Site3dConfiguratorSettingsItem but overwritten in modules\configurator\configurator.js:5689

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

unit

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5716

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

part

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5726

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

searchPart

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5736

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

relatedSettings

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5746

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

price

Number

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5756

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

isVisible

Boolean

Inherited from Site3dConfiguratorSettingsItem but overwritten in modules\configurator\configurator.js:5766

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

isEnabled

Boolean

Inherited from Site3dConfiguratorSettingsItem but overwritten in modules\configurator\configurator.js:5786

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

isAutoStart

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5806

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

isSaved

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5816

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

isExported

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5826

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

isNeedUpdate

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5836

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

isShowLoading

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5846

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

isAutoCreate

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5856

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

updateEvent

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5866

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

updateValue

Function

Inherited from Site3dConfiguratorSettingsItem but overwritten in modules\configurator\configurator.js:5876

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

prepare

Function

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5896

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

change

Function

Inherited from Site3dConfiguratorSettingsItem but overwritten in modules\configurator\configurator.js:5906

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

changeInit

Function

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5926

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

valuePrev

Any

Inherited from Site3dConfiguratorSettingsItem but overwritten in modules\configurator\configurator.js:5936

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

unitData

Object

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5956

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

unitShortcut

String

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5966

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

domElement

HTMLElement | null

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5976

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

isChanged

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5986

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

isOnChange

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:5996

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

isLoaded

Boolean

Inherited from Site3dConfiguratorSettingsItem: modules\configurator\configurator.js:6006

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