API Docs for: 1.0.0
Show:

Site3dConfiguratorSettingsItem Class

Defined in: modules\configurator\configurator.js:2862
Module: Configurator

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

Constructor

Site3dConfiguratorSettingsItem

(
  • configurator
  • name
  • options
)

Defined in modules\configurator\configurator.js:2862

Parameters:

  • configurator Site3dConfigurator

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

  • name String

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

  • options Object

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

Methods

setParams

()

Defined in modules\configurator\configurator.js:3205

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

getContent

() String

Defined in modules\configurator\configurator.js:3213

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

Returns:

String:

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

getContent

() String

Defined in modules\configurator\configurator.js:3223

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

Returns:

String:

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

init

(
  • container
)

Defined in modules\configurator\configurator.js:3232

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

Parameters:

  • container Object

    HTML-контейнер

updateContent

(
  • value
)

Defined in modules\configurator\configurator.js:3243

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

Parameters:

  • value String

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

updateContentValue

(
  • value
)

Defined in modules\configurator\configurator.js:3257

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

Parameters:

  • value String

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

run

() async

Defined in modules\configurator\configurator.js:3266

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

setValue

(
  • value
)
async

Defined in modules\configurator\configurator.js:3293

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

Parameters:

  • value Any

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

onChange

(
  • value
)
async

Defined in modules\configurator\configurator.js:3308

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

Parameters:

  • value String

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

setValuePrevSilent

()

Defined in modules\configurator\configurator.js:3344

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

getFormatValue

() String

Defined in modules\configurator\configurator.js:3353

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

Returns:

String:

Отформатированное значение настройки

clearContent

()

Defined in modules\configurator\configurator.js:3363

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

Properties

configurator

Site3dConfigurator

Defined in modules\configurator\configurator.js:2920

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

name

String

Defined in modules\configurator\configurator.js:2930

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

type

String

Defined in modules\configurator\configurator.js:2940

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

valueType

String

Defined in modules\configurator\configurator.js:2950

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

caption

String

Defined in modules\configurator\configurator.js:2960

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

group

String

Defined in modules\configurator\configurator.js:2970

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

sort

Number

Defined in modules\configurator\configurator.js:2980

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

value

Any

Defined in modules\configurator\configurator.js:2990

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

value

Unknown

Defined in modules\configurator\configurator.js:3000

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

Sub-properties:

  • value Any

    Значение

unit

String

Defined in modules\configurator\configurator.js:3015

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

part

String

Defined in modules\configurator\configurator.js:3025

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

isVisible

Boolean

Defined in modules\configurator\configurator.js:3035

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

isAutoStart

Boolean

Defined in modules\configurator\configurator.js:3045

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

isSaved

Boolean

Defined in modules\configurator\configurator.js:3055

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

isExported

Boolean

Defined in modules\configurator\configurator.js:3065

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

isNeedUpdate

Boolean

Defined in modules\configurator\configurator.js:3075

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

isShowLoading

Boolean

Defined in modules\configurator\configurator.js:3085

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

updateEvent

String

Defined in modules\configurator\configurator.js:3095

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

prepare

Function

Defined in modules\configurator\configurator.js:3105

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

change

Function

Defined in modules\configurator\configurator.js:3115

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

change

Unknown

Defined in modules\configurator\configurator.js:3125

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

Sub-properties:

valuePrev

Any

Defined in modules\configurator\configurator.js:3135

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

valuePrev

Unknown

Defined in modules\configurator\configurator.js:3145

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

Sub-properties:

  • value Any

    Значение

unitData

Object

Defined in modules\configurator\configurator.js:3155

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

domElement

Object

Defined in modules\configurator\configurator.js:3165

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

isChanged

Boolean

Defined in modules\configurator\configurator.js:3175

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

isOnChange

Boolean

Defined in modules\configurator\configurator.js:3185

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

isActive

Boolean

Defined in modules\configurator\configurator.js:3195

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