API Docs for: 1.0.0
Show:

Site3dConfiguratorSettingsItem Class

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

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

Constructor

Site3dConfiguratorSettingsItem

(
  • owner
  • name
  • options
)

Defined in modules\configurator\configurator.js:5172

Parameters:

  • owner Site3dConfiguratorSettings

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

  • name String

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

  • options Object

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

Methods

addOptions

()

Defined in modules\configurator\configurator.js:5640

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

getDomElements

(
  • domElement
)
HTMLElement[]

Defined in modules\configurator\configurator.js:5657

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

Parameters:

Returns:

HTMLElement[]:

Результат

getContent

() Promise async

Defined in modules\configurator\configurator.js:5673

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

Returns:

Promise:

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

getContentInside

() Promise async

Defined in modules\configurator\configurator.js:5686

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

Returns:

Promise:

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

getContentInsideAdditional

() Promise async

Defined in modules\configurator\configurator.js:5696

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

Returns:

Promise:

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

init

(
  • container
  • options
)

Defined in modules\configurator\configurator.js:5707

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

Parameters:

  • container HTMLElement

    HTML-контейнер

  • options Object

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

initContent

()

Defined in modules\configurator\configurator.js:5735

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

updateContent

(
  • value
)

Defined in modules\configurator\configurator.js:5743

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

Parameters:

  • value String

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

updateContentValue

(
  • value
)

Defined in modules\configurator\configurator.js:5759

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

Parameters:

  • value Object

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

run

(
  • options
)
async

Defined in modules\configurator\configurator.js:5784

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

Parameters:

  • options Object

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

update

() async

Defined in modules\configurator\configurator.js:5837

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

setValue

(
  • value
  • options
)
async

Defined in modules\configurator\configurator.js:5848

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

Parameters:

  • value Any

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

  • options Object

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

runChangeInit

(
  • value
  • options
)
async

Defined in modules\configurator\configurator.js:5866

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

Parameters:

  • value Any

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

  • options Object

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

onChange

(
  • value
  • options
)
async

Defined in modules\configurator\configurator.js:5886

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

Parameters:

  • value String | object

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

  • options Object

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

setValuePrevSilent

()

Defined in modules\configurator\configurator.js:5930

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

getFormatCaption

(
  • valueData
)
String

Defined in modules\configurator\configurator.js:5939

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

Parameters:

  • valueData Object

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

Returns:

String:

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

getFormatValue

(
  • value
  • options
)
Any

Defined in modules\configurator\configurator.js:5955

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

Parameters:

  • value String | object

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

  • options Object

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

Returns:

Any:

Результат

getPresentValue

(
  • options
)
String

Defined in modules\configurator\configurator.js:5972

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

Parameters:

  • options Object

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

Returns:

String:

Результат

getSaveValue

() Any

Defined in modules\configurator\configurator.js:5983

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

Returns:

Any:

Результат

enable

()

Defined in modules\configurator\configurator.js:5993

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

disable

()

Defined in modules\configurator\configurator.js:6002

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

updateEnabled

(
  • container
)

Defined in modules\configurator\configurator.js:6011

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

Parameters:

clearContent

()

Defined in modules\configurator\configurator.js:6036

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

getCurrentPrice

() Number

Defined in modules\configurator\configurator.js:6045

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

Returns:

Number:

Результат

getTotalPrice

() Number

Defined in modules\configurator\configurator.js:6055

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

Returns:

Number:

Результат

Properties

owner

Site3dConfiguratorSettings

Defined in modules\configurator\configurator.js:5233

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

configurator

Site3dConfigurator

Defined in modules\configurator\configurator.js:5243

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

model

Site3dModel

Defined in modules\configurator\configurator.js:5253

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

name

String

Defined in modules\configurator\configurator.js:5263

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

options

Object

Defined in modules\configurator\configurator.js:5273

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

type

String

Defined in modules\configurator\configurator.js:5283

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

valueType

String

Defined in modules\configurator\configurator.js:5293

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

caption

String

Defined in modules\configurator\configurator.js:5303

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

group

String

Defined in modules\configurator\configurator.js:5313

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

panels

String[]

Defined in modules\configurator\configurator.js:5323

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

sort

Number

Defined in modules\configurator\configurator.js:5333

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

value

Any

Defined in modules\configurator\configurator.js:5343

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

value

Unknown

Defined in modules\configurator\configurator.js:5353

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

Sub-properties:

  • value Any

    Значение

unit

String

Defined in modules\configurator\configurator.js:5370

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

part

String

Defined in modules\configurator\configurator.js:5380

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

price

Number

Defined in modules\configurator\configurator.js:5390

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

isVisible

Boolean

Defined in modules\configurator\configurator.js:5400

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

isEnabled

Boolean

Defined in modules\configurator\configurator.js:5410

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

isEnabled

Unknown

Defined in modules\configurator\configurator.js:5420

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

isAutoStart

Boolean

Defined in modules\configurator\configurator.js:5430

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

isSaved

Boolean

Defined in modules\configurator\configurator.js:5440

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

isExported

Boolean

Defined in modules\configurator\configurator.js:5450

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

isNeedUpdate

Boolean

Defined in modules\configurator\configurator.js:5460

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

isShowLoading

Boolean

Defined in modules\configurator\configurator.js:5470

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

isAutoCreate

Boolean

Defined in modules\configurator\configurator.js:5480

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

updateEvent

String

Defined in modules\configurator\configurator.js:5490

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

updateValue

Function

Defined in modules\configurator\configurator.js:5500

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

updateValue

Unknown

Defined in modules\configurator\configurator.js:5510

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

Sub-properties:

prepare

Function

Defined in modules\configurator\configurator.js:5520

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

change

Function

Defined in modules\configurator\configurator.js:5530

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

change

Unknown

Defined in modules\configurator\configurator.js:5540

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

Sub-properties:

changeInit

Function

Defined in modules\configurator\configurator.js:5550

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

valuePrev

Any

Defined in modules\configurator\configurator.js:5560

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

valuePrev

Unknown

Defined in modules\configurator\configurator.js:5570

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

Sub-properties:

  • value Any

    Значение

unitData

Object

Defined in modules\configurator\configurator.js:5580

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

unitShortcut

String

Defined in modules\configurator\configurator.js:5590

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

domElement

HTMLElement | null

Defined in modules\configurator\configurator.js:5600

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

isChanged

Boolean

Defined in modules\configurator\configurator.js:5610

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

isOnChange

Boolean

Defined in modules\configurator\configurator.js:5620

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

isLoaded

Boolean

Defined in modules\configurator\configurator.js:5630

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