API Docs for: 1.0.0
Show:

Site3dConfiguratorSettingsItem Class

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

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

Constructor

Site3dConfiguratorSettingsItem

(
  • configurator
  • name
  • options
)

Defined in modules\configurator\configurator.js:3787

Parameters:

  • configurator Site3dConfigurator

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

  • name String

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

  • options Object

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

Methods

addOptions

()

Defined in modules\configurator\configurator.js:4153

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

getContent

() String

Defined in modules\configurator\configurator.js:4170

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

Returns:

String:

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

getContent

() String

Defined in modules\configurator\configurator.js:4182

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

Returns:

String:

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

init

(
  • container
)

Defined in modules\configurator\configurator.js:4191

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

Parameters:

  • container Object

    HTML-контейнер

initContent

()

Defined in modules\configurator\configurator.js:4206

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

updateContent

(
  • value
)

Defined in modules\configurator\configurator.js:4214

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

Parameters:

  • value String

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

updateContentValue

(
  • value
)

Defined in modules\configurator\configurator.js:4228

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

Parameters:

  • value String

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

run

() async

Defined in modules\configurator\configurator.js:4237

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

setValue

(
  • value
)
async

Defined in modules\configurator\configurator.js:4261

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

Parameters:

  • value Any

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

onChange

(
  • value
)
async

Defined in modules\configurator\configurator.js:4276

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

Parameters:

  • value String | object

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

setValuePrevSilent

()

Defined in modules\configurator\configurator.js:4312

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

getFormatValue

() String

Defined in modules\configurator\configurator.js:4321

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

Returns:

String:

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

clearContent

()

Defined in modules\configurator\configurator.js:4331

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

Properties

configurator

Site3dConfigurator

Defined in modules\configurator\configurator.js:3838

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

name

String

Defined in modules\configurator\configurator.js:3848

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

options

Object

Defined in modules\configurator\configurator.js:3858

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

type

String

Defined in modules\configurator\configurator.js:3868

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

valueType

String

Defined in modules\configurator\configurator.js:3878

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

caption

String

Defined in modules\configurator\configurator.js:3888

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

group

String

Defined in modules\configurator\configurator.js:3898

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

sort

Number

Defined in modules\configurator\configurator.js:3908

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

value

Any

Defined in modules\configurator\configurator.js:3918

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

value

Unknown

Defined in modules\configurator\configurator.js:3928

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

Sub-properties:

  • value Any

    Значение

unit

String

Defined in modules\configurator\configurator.js:3943

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

part

String

Defined in modules\configurator\configurator.js:3953

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

isVisible

Boolean

Defined in modules\configurator\configurator.js:3963

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

isAutoStart

Boolean

Defined in modules\configurator\configurator.js:3973

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

isSaved

Boolean

Defined in modules\configurator\configurator.js:3983

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

isExported

Boolean

Defined in modules\configurator\configurator.js:3993

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

isNeedUpdate

Boolean

Defined in modules\configurator\configurator.js:4003

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

isShowLoading

Boolean

Defined in modules\configurator\configurator.js:4013

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

isAutoCreate

Boolean

Defined in modules\configurator\configurator.js:4023

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

updateEvent

String

Defined in modules\configurator\configurator.js:4033

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

prepare

Function

Defined in modules\configurator\configurator.js:4043

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

change

Function

Defined in modules\configurator\configurator.js:4053

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

change

Unknown

Defined in modules\configurator\configurator.js:4063

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

Sub-properties:

valuePrev

Any

Defined in modules\configurator\configurator.js:4073

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

valuePrev

Unknown

Defined in modules\configurator\configurator.js:4083

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

Sub-properties:

  • value Any

    Значение

unitData

Object

Defined in modules\configurator\configurator.js:4093

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

unitShortcut

String

Defined in modules\configurator\configurator.js:4103

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

domElement

Object

Defined in modules\configurator\configurator.js:4113

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

isChanged

Boolean

Defined in modules\configurator\configurator.js:4123

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

isOnChange

Boolean

Defined in modules\configurator\configurator.js:4133

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

isActive

Boolean

Defined in modules\configurator\configurator.js:4143

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