API Docs for: 1.0.0
Show:

Site3dConfiguratorSettingsItem Class

Defined in: modules\configurator\configurator.js:5168
Module: Site3dConfigurator

Абстрактный класс элемента настроек конфигуратора и его элементов

Constructor

Site3dConfiguratorSettingsItem

(
  • owner
  • name
  • options
)

Defined in modules\configurator\configurator.js:5168

Parameters:

  • owner Site3dConfiguratorSettings

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

  • name String

    Имя элемента настроек

  • options Object

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

Methods

addOptions

()

Defined in modules\configurator\configurator.js:5636

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

getDomElements

(
  • domElement
)
HTMLElement[]

Defined in modules\configurator\configurator.js:5653

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

Parameters:

Returns:

HTMLElement[]:

Результат

getContent

() Promise async

Defined in modules\configurator\configurator.js:5669

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

Returns:

Promise:

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

getContentInside

() Promise async

Defined in modules\configurator\configurator.js:5682

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

Returns:

Promise:

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

getContentInsideAdditional

() Promise async

Defined in modules\configurator\configurator.js:5692

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

Returns:

Promise:

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

init

(
  • container
  • options
)

Defined in modules\configurator\configurator.js:5703

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

Parameters:

  • container HTMLElement

    HTML-контейнер

  • options Object

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

initContent

()

Defined in modules\configurator\configurator.js:5731

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

updateContent

(
  • value
)

Defined in modules\configurator\configurator.js:5739

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

Parameters:

  • value String

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

updateContentValue

(
  • value
)

Defined in modules\configurator\configurator.js:5755

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

Parameters:

  • value Object

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

run

(
  • options
)
async

Defined in modules\configurator\configurator.js:5780

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

Parameters:

  • options Object

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

update

() async

Defined in modules\configurator\configurator.js:5833

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

setValue

(
  • value
  • options
)
async

Defined in modules\configurator\configurator.js:5844

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

Parameters:

  • value Any

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

  • options Object

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

runChangeInit

(
  • value
  • options
)
async

Defined in modules\configurator\configurator.js:5862

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

Parameters:

  • value Any

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

  • options Object

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

onChange

(
  • value
  • options
)
async

Defined in modules\configurator\configurator.js:5882

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

Parameters:

  • value String | object

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

  • options Object

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

setValuePrevSilent

()

Defined in modules\configurator\configurator.js:5926

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

getFormatCaption

(
  • valueData
)
String

Defined in modules\configurator\configurator.js:5935

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

Parameters:

  • valueData Object

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

Returns:

String:

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

getFormatValue

(
  • value
  • options
)
Any

Defined in modules\configurator\configurator.js:5951

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

Parameters:

  • value String | object

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

  • options Object

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

Returns:

Any:

Результат

getPresentValue

(
  • options
)
String

Defined in modules\configurator\configurator.js:5968

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

Parameters:

  • options Object

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

Returns:

String:

Результат

getSaveValue

() Any

Defined in modules\configurator\configurator.js:5979

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

Returns:

Any:

Результат

enable

()

Defined in modules\configurator\configurator.js:5989

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

disable

()

Defined in modules\configurator\configurator.js:5998

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

updateEnabled

(
  • container
)

Defined in modules\configurator\configurator.js:6007

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

Parameters:

clearContent

()

Defined in modules\configurator\configurator.js:6032

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

getCurrentPrice

() Number

Defined in modules\configurator\configurator.js:6041

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

Returns:

Number:

Результат

getTotalPrice

() Number

Defined in modules\configurator\configurator.js:6051

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

Returns:

Number:

Результат

Properties

owner

Site3dConfiguratorSettings

Defined in modules\configurator\configurator.js:5229

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

configurator

Site3dConfigurator

Defined in modules\configurator\configurator.js:5239

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

model

Site3dModel

Defined in modules\configurator\configurator.js:5249

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

name

String

Defined in modules\configurator\configurator.js:5259

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

options

Object

Defined in modules\configurator\configurator.js:5269

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

type

String

Defined in modules\configurator\configurator.js:5279

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

valueType

String

Defined in modules\configurator\configurator.js:5289

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

caption

String

Defined in modules\configurator\configurator.js:5299

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

group

String

Defined in modules\configurator\configurator.js:5309

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

panels

String[]

Defined in modules\configurator\configurator.js:5319

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

sort

Number

Defined in modules\configurator\configurator.js:5329

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

value

Any

Defined in modules\configurator\configurator.js:5339

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

value

Unknown

Defined in modules\configurator\configurator.js:5349

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

Sub-properties:

  • value Any

    Значение

unit

String

Defined in modules\configurator\configurator.js:5366

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

part

String

Defined in modules\configurator\configurator.js:5376

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

price

Number

Defined in modules\configurator\configurator.js:5386

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

isVisible

Boolean

Defined in modules\configurator\configurator.js:5396

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

isEnabled

Boolean

Defined in modules\configurator\configurator.js:5406

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

isEnabled

Unknown

Defined in modules\configurator\configurator.js:5416

Свойство устанавливает активность настройки

isAutoStart

Boolean

Defined in modules\configurator\configurator.js:5426

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

isSaved

Boolean

Defined in modules\configurator\configurator.js:5436

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

isExported

Boolean

Defined in modules\configurator\configurator.js:5446

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

isNeedUpdate

Boolean

Defined in modules\configurator\configurator.js:5456

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

isShowLoading

Boolean

Defined in modules\configurator\configurator.js:5466

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

isAutoCreate

Boolean

Defined in modules\configurator\configurator.js:5476

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

updateEvent

String

Defined in modules\configurator\configurator.js:5486

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

updateValue

Function

Defined in modules\configurator\configurator.js:5496

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

updateValue

Unknown

Defined in modules\configurator\configurator.js:5506

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

Sub-properties:

prepare

Function

Defined in modules\configurator\configurator.js:5516

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

change

Function

Defined in modules\configurator\configurator.js:5526

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

change

Unknown

Defined in modules\configurator\configurator.js:5536

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

Sub-properties:

changeInit

Function

Defined in modules\configurator\configurator.js:5546

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

valuePrev

Any

Defined in modules\configurator\configurator.js:5556

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

valuePrev

Unknown

Defined in modules\configurator\configurator.js:5566

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

Sub-properties:

  • value Any

    Значение

unitData

Object

Defined in modules\configurator\configurator.js:5576

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

unitShortcut

String

Defined in modules\configurator\configurator.js:5586

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

domElement

HTMLElement | null

Defined in modules\configurator\configurator.js:5596

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

isChanged

Boolean

Defined in modules\configurator\configurator.js:5606

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

isOnChange

Boolean

Defined in modules\configurator\configurator.js:5616

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

isLoaded

Boolean

Defined in modules\configurator\configurator.js:5626

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