API Docs for:
Show:

Site3dWidget Class

Defined in: modules\widget\widget.js:806
Module: Site3dWidget

Класс виджета Site3d

Constructor

Site3dWidget

(
  • containerId
  • name
  • path
  • options
)

Defined in modules\widget\widget.js:806

Parameters:

  • containerId String

    Идентификатор корневого элемента виджета

  • name String

    Имя базовой модели виджета

  • path String

    Путь до базовой модели виджета

  • options Site3dWidgetOptions

    Параметры виджета

Item Index

Methods

Properties

Methods

initShow

()

Defined in modules\widget\widget.js:1753

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

initHide

()

Defined in modules\widget\widget.js:1762

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

loadShow

(
  • info
)

Defined in modules\widget\widget.js:1771

Метод показывает загрузку

Parameters:

  • info Site3dWidgetLoadStatusInfo=

    Объект статуса

loadHide

()

Defined in modules\widget\widget.js:1786

Метод скрывает загрузку

loadSetStatus

(
  • info
)

Defined in modules\widget\widget.js:1795

Метод устанавливает статус загрузки

Parameters:

  • info Site3dWidgetLoadStatusInfo

    Объект статуса

setRender

(
  • renderType
)

Defined in modules\widget\widget.js:1829

Метод устанавливает тип рендера

Parameters:

  • renderType 'actions' | 'full'

    Тип рендера

updateIsRender

(
  • value
  • options
)

Defined in modules\widget\widget.js:1857

Метод обновляет включение или отключение рисования сцены виджета

Parameters:

  • value Boolean=

    Истина, если нужно включить рисование сцены виджета

  • options Site3dWidgetUpdateIsRenderOptions=

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

renderOn

()

Defined in modules\widget\widget.js:1907

Метод включает рисование сцены виджета

renderOff

()

Defined in modules\widget\widget.js:1916

Метод выключает рисование сцены виджета

navButtonUpdate

(
  • name
  • isOn
)

Defined in modules\widget\widget.js:1925

Метод обновляет кнопку навигации

Parameters:

  • name String

    Кодовое обозначение кнопки

  • isOn Boolean

    Истина, если состояние активности

navPanelsShow

()

Defined in modules\widget\widget.js:1957

Метод показывает панели инструментов

navPanelsHide

()

Defined in modules\widget\widget.js:1975

Метод скрывает панели инструментов

navPanelsToggle

()

Defined in modules\widget\widget.js:1993

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

navSkyboxChange

(
  • value
)
async

Defined in modules\widget\widget.js:2009

Метод обрабатывает смену панорамы

Parameters:

  • value String

    Значение списка панорам

fullOn

() async

Defined in modules\widget\widget.js:2030

Метод включает полноэкранный режим

fullOff

() async

Defined in modules\widget\widget.js:2074

Метод выключает полноэкранный режим

updateFullButton

()

Defined in modules\widget\widget.js:2115

Метод обновляет кнопку управления полноэкранным просмотром

fullToggle

() async

Defined in modules\widget\widget.js:2124

Метод переключает полноэкранный режим

fullScreenExit

() async

Defined in modules\widget\widget.js:2141

Метод обрабатывает выход из полноэкранного режима

helpWindowShow

()

Defined in modules\widget\widget.js:2156

Метод показывает окно помощи

helpWindowHide

()

Defined in modules\widget\widget.js:2165

Метод скрывает окно помощи

helpWindowToggle

()

Defined in modules\widget\widget.js:2174

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

rotateOn

()

Defined in modules\widget\widget.js:2183

Метод включает вращение модели

rotateOff

()

Defined in modules\widget\widget.js:2220

Метод выключает вращение модели

rotateStop

()

Defined in modules\widget\widget.js:2231

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

rotateToggle

()

Defined in modules\widget\widget.js:2258

Метод переключает вращение модели

updateRotateButton

()

Defined in modules\widget\widget.js:2296

Метод обновляет кнопку управления вращением камеры

lightToggle

()

Defined in modules\widget\widget.js:2325

Метод переключает свечение

updateLightButton

()

Defined in modules\widget\widget.js:2334

Метод обновляет кнопку управления свечением

isCanAnim

() Boolean

Defined in modules\widget\widget.js:2343

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

Returns:

Boolean:

Результат

getAnimOptions

() Site3dWidgetAnimControlOptions

Defined in modules\widget\widget.js:2353

Метод возвращает параметры анимации

Returns:

Site3dWidgetAnimControlOptions:

getAnimNumber

(
  • [number]
)
Number

Defined in modules\widget\widget.js:2383

Метод возвращает номер анимации

Parameters:

  • [number] Site3dWidgetAnimControlNumberItem= optional

    Как в animControl.number; по умолчанию из getAnimOptions()

Returns:

Number:

animOn

()

Defined in modules\widget\widget.js:2399

Метод включает анимацию

animOff

()

Defined in modules\widget\widget.js:2462

Метод выключает анимацию

animToggle

()

Defined in modules\widget\widget.js:2494

Метод переключает анимацию

animScroll

(
  • delta
  • options
)

Defined in modules\widget\widget.js:2510

Метод осуществляет ручную анимацию

Parameters:

  • delta Number

    Шаг изменения анимации

  • options Site3dWidgetAnimControlOptions

    Параметры анимации

animByEventOn

(
  • eventName
)

Defined in modules\widget\widget.js:2527

Метод включает анимацию по событию

Parameters:

  • eventName String

    Имя события

animByEventOff

(
  • eventName
)

Defined in modules\widget\widget.js:2569

Метод выключает анимацию по событию

Parameters:

  • eventName String

    Имя события

animStop

()

Defined in modules\widget\widget.js:2588

Метод останавливает все анимации

animReset

()

Defined in modules\widget\widget.js:2610

Метод выключает все анимации с начала

animManualOn

()

Defined in modules\widget\widget.js:2625

Метод включает режим ручной анимации

animManualOff

()

Defined in modules\widget\widget.js:2642

Метод выключает режим ручной анимации

animManualToggle

()

Defined in modules\widget\widget.js:2659

Метод переключает ручной режим анимации

animShowMark

(
  • options
)

Defined in modules\widget\widget.js:2675

Метод показывает текущую метку анимации

Parameters:

  • options Site3dWidgetAnimControlOptions

    Параметры анимации

animRemoveMarks

(
  • marks
)

Defined in modules\widget\widget.js:2697

Метод удаляет метки анимации

Parameters:

  • marks Site3dWidgetAnimControlMark=

    Метки

animClearMarksTimer

()

Defined in modules\widget\widget.js:2714

Метод удаляет таймер анимации

skyboxShow

() async

Defined in modules\widget\widget.js:2728

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

skyboxHide

() async

Defined in modules\widget\widget.js:2751

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

skyboxToggle

() async

Defined in modules\widget\widget.js:2774

Метод переключает видимость панорамы

updateSkyboxButton

()

Defined in modules\widget\widget.js:2791

Метод обновляет кнопку управления показом панорамы

sizeOn

()

Defined in modules\widget\widget.js:2800

Метод включает показ размеров модели

sizeOff

()

Defined in modules\widget\widget.js:2852

Метод выключает показ размеров модели

sizeToggle

()

Defined in modules\widget\widget.js:2868

Метод переключает показ размеров модели

updateSizeButton

()

Defined in modules\widget\widget.js:2884

Метод обновляет кнопку управления показом размеров модели

labelOn

()

Defined in modules\widget\widget.js:2893

Метод включает показ меток модели

labelOff

()

Defined in modules\widget\widget.js:2918

Метод выключает показ меток модели

labelToggle

()

Defined in modules\widget\widget.js:2943

Метод переключает показ меток модели

updateLabelButton

()

Defined in modules\widget\widget.js:2959

Метод обновляет кнопку управления показом меток модели

painterOn

()

Defined in modules\widget\widget.js:2968

Метод включает раскраску по клику

painterOff

()

Defined in modules\widget\widget.js:2978

Метод выключает раскраску по клику

painterToggle

()

Defined in modules\widget\widget.js:2988

Метод переключает раскраску по клику

updatePainterButton

()

Defined in modules\widget\widget.js:3004

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

vrOn

() async

Defined in modules\widget\widget.js:3013

Метод включает режим виратуальной реальности

vrOff

()

Defined in modules\widget\widget.js:3032

Метод выключает режим виратуальной реальности

vrToggle

() async

Defined in modules\widget\widget.js:3041

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

updateVrButton

()

Defined in modules\widget\widget.js:3058

Метод обновляет кнопку управления VR

arOn

() Object async

Defined in modules\widget\widget.js:3074

Метод включает режим дополненной реальности

Returns:

Object:

Служебный объект результата (расширяется по платформе)

arOff

()

Defined in modules\widget\widget.js:3382

Метод выключает режим дополненной реальности

arToggle

() async

Defined in modules\widget\widget.js:3391

Метод переключает режим дополненной реальности

updateArButton

()

Defined in modules\widget\widget.js:3408

Метод обновляет кнопку управления AR

saveFile

(
  • category
  • blob
  • options
)
Promise async

Defined in modules\widget\widget.js:3445

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

Parameters:

  • category String

    Категория

  • blob Blob

    Данные файла

  • options Site3dWidgetSaveFileOptions=

    Параметры

Returns:

Promise:

Результат

saveTextureFromObjectURL

(
  • texture
)
Promise async

Defined in modules\widget\widget.js:3547

Метод сохраняет файл текстуры из ссылки на объект и возвращает полный путь к файлу

Parameters:

  • texture String | Texture

    URL объекта или уже загруженная текстура

Returns:

Promise:

Результат

saveSettingTexture

(
  • setting
)
async

Defined in modules\widget\widget.js:3565

Метод сохраняет файл текстуры в сохраненных данных настройки

Parameters:

  • setting Site3dWidgetConfiguratorSettingTexture

    Сохраненные данные настройки

getShareImageAsHTML

(
  • options
)
Promise async

Defined in modules\widget\widget.js:3660

Метод возвращает html скриншота виджета

Parameters:

  • options Site3dWidgetShareImageAsHTMLOptions=

    Параметры

Returns:

Promise:

Результат

getShareDataAsHTML

() Promise async

Defined in modules\widget\widget.js:3692

Метод возвращает html описания виджета

Returns:

Promise:

Результат

getShareDataAsPdf

() Promise async

Defined in modules\widget\widget.js:3869

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

Returns:

Promise:

Результат в виде Blob

share

(
  • path
)
async

Defined in modules\widget\widget.js:3895

Метод показывает окно, где можно поделиться PDF или ссылкой

Parameters:

  • path String=

    URL для режима «ссылка»; без аргумента — PDF

download

() async

Defined in modules\widget\widget.js:4015

Метод скачивания файла модели

exportImage

(
  • options
)
Blob | Null async

Defined in modules\widget\widget.js:4035

Метод создает скриншот сцены

Parameters:

  • options Site3dWidgetExportImageOptions=

    Параметры экспорта изображения

Returns:

Blob | Null:

Итоговый файл изображения

exportVideo

(
  • options
)
Blob | Null async

Defined in modules\widget\widget.js:4120

Метод создает видео

Parameters:

  • options Site3dWidgetExportVideoOptions=

    Параметры создания видео

Returns:

Blob | Null:

Итоговый файл видео

appendNav

(
  • domElement
)

Defined in modules\widget\widget.js:4358

Метод переносит навигацию в другой контейнер

Parameters:

  • domElement HTMLElement

    Контейнер

loadStyleString

(
  • elem
  • styleString
)
async

Defined in modules\widget\widget.js:4368

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

Parameters:

  • elem HTMLElement

    DOM-элемент стилей

  • styleString String

    Строка стилей

loadStyleFile

(
  • elem
  • path
  • fileName
)
async

Defined in modules\widget\widget.js:4396

Метод вставляет файл стилей

Parameters:

  • elem HTMLElement

    DOM-элемент стилей

  • path String

    Путь до файла стилей

  • fileName String

    Имя файла стилей

loadStyle

(
  • elem
  • category
  • value
)
async

Defined in modules\widget\widget.js:4416

Метод вставляет файл стилей

Parameters:

  • elem HTMLElement

    DOM-элемент стилей

  • category String

    Категория

  • value String

    Значение

showNav

()

Defined in modules\widget\widget.js:4439

Метод показывает навигацию

hideNav

()

Defined in modules\widget\widget.js:4454

Метод скрывает навигацию

showModel

()

Defined in modules\widget\widget.js:4487

Метод показывает модель

hideModel

()

Defined in modules\widget\widget.js:4503

Метод скрывает модель

updateTheme

(
  • value
)
async

Defined in modules\widget\widget.js:4512

Метод обновляет тему оформления

Parameters:

  • value String

    Кодовое обозначение

updateAppearance

(
  • value
)
async

Defined in modules\widget\widget.js:4535

Метод обновляет внешний вид виджета

Parameters:

  • value Site3dWidgetAppearanceOptions=

    Внешний вид (категории CSS-переменных)

updateFontFamily

(
  • value
)
async

Defined in modules\widget\widget.js:4572

Метод обновляет шрифт виджета

Parameters:

  • value String

    Название шрифта

updateBorderRadius

(
  • value
)

Defined in modules\widget\widget.js:4596

Метод обновляет радиус закругления виджета

Parameters:

  • value Number

    Радиус закругления

updateBackgroundColor

(
  • value
)

Defined in modules\widget\widget.js:4611

Метод обновляет цвет фона

Parameters:

  • value String

    Цвет фона в HEX формате с альфа каналом

updatePreloadBackgroundColor

(
  • value
)

Defined in modules\widget\widget.js:4626

Метод обновляет цвет фона окна загрузки

Parameters:

  • value String

    Цвет фона в HEX формате с альфа каналом

updatePreloadBackgroundImage

(
  • value
)

Defined in modules\widget\widget.js:4641

Метод обновляет изображение фона окна загрузки

Parameters:

  • value String

    Путь до изображения

updatePreloadPoster

(
  • value
)

Defined in modules\widget\widget.js:4659

Метод обновляет изображение кнопки загрузки

Parameters:

  • value String

    Путь до изображения

updatePreloadButton

(
  • value
)

Defined in modules\widget\widget.js:4675

Метод обновляет стандартную кнопку загрузки

Parameters:

  • value Site3dWidgetPreloadButtonOptions

    Параметры кнопки загрузки

updateScaleFading

(
  • value
)

Defined in modules\widget\widget.js:4705

Метод обновляет затухание при масштабировании

Parameters:

  • value Number

    Значение от 0 до 10

updateRotateFading

(
  • value
)

Defined in modules\widget\widget.js:4728

Метод обновляет затухание при вращении

Parameters:

  • value Number

    Значение от 0 до 10

updatePosCorrection

(
  • value
)
async

Defined in modules\widget\widget.js:4748

Метод обновляет коррекцию смещения

Parameters:

  • value Site3dWidgetPosCorrection=

    Коррекция позиции (% от размера модели)

updateSizeCorrection

(
  • value
)
async

Defined in modules\widget\widget.js:4790

Метод обновляет коррекцию размера

Parameters:

  • value Number

    Значение

updateRotateCorrection

(
  • value
)
async

Defined in modules\widget\widget.js:4840

Метод обновляет коррекцию вращения

Parameters:

  • value Number=

    Коррекция начального вращения модели

updateMoveControl

(
  • value
)
async

Defined in modules\widget\widget.js:4871

Метод обновляет управление перемещением камеры

Parameters:

  • value Object=

    Частичное обновление options.moveControl

updateScaleControl

(
  • value
)

Defined in modules\widget\widget.js:4923

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

Parameters:

  • value Object=

    Частичное обновление options.scaleControl

updateRotateControl

(
  • value
)

Defined in modules\widget\widget.js:4968

Метод обновляет управление вращением камеры

Parameters:

  • value Object=

    Частичное обновление options.rotateControl

updateSizeControl

(
  • value
)

Defined in modules\widget\widget.js:4993

Метод обновляет управление показом размеров модели

Parameters:

  • value Object=

    Новое значение options.sizeControl

updateAmbientLight

(
  • value
)

Defined in modules\widget\widget.js:5015

Метод обновляет общее освещение

Parameters:

  • value Object=

    Параметры options.ambientLight для сцены

updateDirectionalLight

(
  • value
  • options
)

Defined in modules\widget\widget.js:5035

Метод обновляет направленное освещение

Parameters:

  • value Site3dWidgetDirectionalLightItem | Site3dWidgetDirectionalLightItem=

    Источник(и) света

  • options Site3dWidgetDirectionalLightCallOptions=

    isUp / isAdditional

updateDirectionalLights

()

Defined in modules\widget\widget.js:5080

Метод обновляет все направленное освещение

restoreMaterialParams

(
  • paramNames
)

Defined in modules\widget\widget.js:5091

Метод восстанавливает параметры материала у модели конфигуратора

Parameters:

  • paramNames String

    Названия сохраняемых параметров

updateGraphics

(
  • value
)
async

Defined in modules\widget\widget.js:5106

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

Parameters:

  • value Object=

    Новый блок options.graphics

updatePainter

(
  • [value]
  • [options]
)
Void

Defined in modules\widget\widget.js:5354

Метод обновляет раскраску

Parameters:

  • [value] Site3dWidgetPainterValue= optional

    Мерж в options.painter

  • [options] Site3dWidgetUpdatePainterOptions= optional

    Флаги вызова

Returns:

Void:

updateModelPainter

() Boolean

Defined in modules\widget\widget.js:5374

Метод устанавливает клики у модели и её элементов для раскраски

Returns:

Boolean:

Результат

updateModelClicks

()

Defined in modules\widget\widget.js:5446

Метод устанавливает клики у модели и её элементов

updateLod

() async

Defined in modules\widget\widget.js:5480

Метод обновляет уровень детализации модели

updateFloor

(
  • value
  • options
)
async

Defined in modules\widget\widget.js:5561

Метод обновляет пол

Parameters:

  • value Site3dWidgetFloorOptions=

    Блок пола

  • options Site3dWidgetFloorUpdateCallOptions=

    Доп. вызов (needRebuild)

updateSkyboxModel

() async

Defined in modules\widget\widget.js:5650

Метод обновляет модель панорамы

updateSkybox

(
  • value
  • options
)
async

Defined in modules\widget\widget.js:5690

Метод обновляет варианты панорамы

Parameters:

  • value Site3dWidgetSkyboxOptions=

    Блок skybox

  • options Object=

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

updateLabels

(
  • [value]
)
async

Defined in modules\widget\widget.js:5875

Метод обновляет метки

Parameters:

  • [value] Site3dWidgetLabelsOptions optional

    Данные меток

updateConfigurator

(
  • value
  • options
)
async

Defined in modules\widget\widget.js:6355

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

Parameters:

  • value Object=

    Частичное обновление options.configurator

  • options Object=

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

updateConfiguratorInLabels

() async

Defined in modules\widget\widget.js:6591

Метод обновляет информацию от конфигуратора в метках

updateScreenSizeCorrection

(
  • options
)

Defined in modules\widget\widget.js:6680

Метод обновляет настройки коррекции графики в зависимости от размеров отображаемых частей модели

Parameters:

  • options Site3dWidgetScreenSizeCorrectionOptions=

    Например start: true при старте

updateAr

(
  • value
)

Defined in modules\widget\widget.js:6844

Метод обновляет AR

Parameters:

  • value Object=

    Частичное обновление options.ar

updateNavButtons

(
  • value
)
async

Defined in modules\widget\widget.js:6860

Метод обновляет кнопки навигации

Parameters:

  • value String | Object

    Список кнопок или карта флагов по имени панели

updateAnimControl

(
  • [value]
)

Defined in modules\widget\widget.js:7192

Метод обновляет управление анимацией

Parameters:

  • [value] Site3dWidgetAnimControlOptions= optional

    Параметры animControl

updateModelAnimControl

() Boolean

Defined in modules\widget\widget.js:7390

Метод устанавливает события у модели для управления анимацией

Returns:

Boolean:

Результат

updateAnimButton

()

Defined in modules\widget\widget.js:7438

Метод обновляет кнопку управления анимацией

updateNavHelp

(
  • value
)

Defined in modules\widget\widget.js:7527

Метод обновляет панель помощи

Parameters:

  • value Object | Boolean=

    options.navHelp или false

updateNavPanel

(
  • name
  • content
)

Defined in modules\widget\widget.js:7559

Метод обновляет дополнительную панель

Parameters:

  • name String

    Имя панели

  • content String | HTMLElement=

    HTML-строка или массив узлов

selectNavPanel

(
  • name
)

Defined in modules\widget\widget.js:7601

Метод выбирает дополнительную панель

Parameters:

  • name String

    Имя панели

enableNavPanel

(
  • name
)

Defined in modules\widget\widget.js:7653

Метод активирует дополнительную панель

Parameters:

  • name String

    Имя панели

disableNavPanel

(
  • name
)

Defined in modules\widget\widget.js:7674

Метод деактивирует дополнительную панель

Parameters:

  • name String

    Имя панели

updateNavPanels

()

Defined in modules\widget\widget.js:7697

Метод обновляет показ дополнительных панелей

updateNavStart

(
  • value
)

Defined in modules\widget\widget.js:7726

Метод обновляет состояние навигации при старте

Parameters:

  • value Object=

    Блок options.navStart

updateWatermark

(
  • [value]
)
Void

Defined in modules\widget\widget.js:7810

Метод обновляет водяной знак

Parameters:

  • [value] Object= optional

    Блок options.watermark

Returns:

Void:

updateStartRotate

(
  • value
)

Defined in modules\widget\widget.js:7836

Метод обновляет вращение камеры вокруг модели после старта сцены

Parameters:

  • value Object=

    Блок options.startRotate

stopStartRotate

()

Defined in modules\widget\widget.js:7849

Метод останавливает вращение камеры вокруг модели после старта сцены

updateStartHelp

(
  • value
)

Defined in modules\widget\widget.js:7862

Метод обновляет показ анимационных иконок после старта сцены

Parameters:

  • value Object=

    Блок options.startHelp

stopStartHelp

()

Defined in modules\widget\widget.js:7939

Метод останавливает показ анимационных иконок после старта сцены

updateAutoRotate

(
  • value
)

Defined in modules\widget\widget.js:7959

Метод обновляет автовращение

Parameters:

  • value Object=

    Блок options.autoRotate

updateTargetControl

(
  • value
)

Defined in modules\widget\widget.js:7982

Метод обновляет центр вращения и масштабирования

Parameters:

  • value (false | Number | Object)=

    false, массив target или объект

updateCamera

(
  • value
)
async

Defined in modules\widget\widget.js:8007

Метод обновляет параметры камеры

Parameters:

  • value Object=

    Частичное обновление options.camera

updateSizeInfo

()

Defined in modules\widget\widget.js:8091

Метод обновляет показ размеров модели

updateNavShare

(
  • value
)

Defined in modules\widget\widget.js:8120

Метод обновляет информацию о возможностях поделиться

Parameters:

  • value Object=

    Блок options.navShare

moveToInitView

() async

Defined in modules\widget\widget.js:8161

Метод перемещает камеру к первоначальному виду

moveToLabel

(
  • index
)

Defined in modules\widget\widget.js:8184

Метод перемещает камеру к метке или первоначальному виду

Parameters:

  • index Number

    Индекс метки (начиная с 1) или 0 для первоначального вида

moveToModelPart

(
  • name
  • options
)

Defined in modules\widget\widget.js:8200

Метод перемещает камеру к части модели

Parameters:

  • name String

    Имя части модели

  • options Site3dWidgetMoveToModelPartOptions=

    Дистанция, углы, масштаб обзора

setStyles

(
  • name
  • styles
  • domElement
)

Defined in modules\widget\widget.js:8235

Метод устанавливает стили

Parameters:

  • name String

    Имя префикса CSS-переменных

  • styles Object

    Вложенная карта значений

  • domElement HTMLElement=

    Область видимости (document.body по умолчанию)

event

(
  • name
  • call
)

Defined in modules\widget\widget.js:8247

Метод подписывает на события виджета

Parameters:

  • name String

    Имя события

  • call Function(!Event):void

    Обработчик

removeEvent

(
  • name
  • call
)

Defined in modules\widget\widget.js:8258

Метод удаляет подписку на события виджета

Parameters:

  • name String

    Имя события

  • call Function(!Event):void

    Тот же callback, что в {@link Site3dWidget#event}

load

() async

Defined in modules\widget\widget.js:8269

Метод загружает виджет

saveConfiguratorStat

() async

Defined in modules\widget\widget.js:8953

Метод сохраняет статистику

getConfiguratorInfo

() Object

Defined in modules\widget\widget.js:8987

Метод возвращает информацию о выборе пользователя в конфигураторе

Returns:

Object:

{ items: { caption, settings: { caption, data }[] }[] }

clear

()

Defined in modules\widget\widget.js:9025

Метод очистки виджета

widget

(
  • containerId
  • name
  • path
  • options
)
Site3dWidget static

Defined in modules\widget\widget.js:9188

Метод создания 3D виджета

Parameters:

  • containerId String

    Идентификатор HTML-контейнера

  • name String

    Имя модели

  • path String

    Путь до модели

  • options Site3dWidgetOptions

    Параметры виджета

Returns:

Site3dWidget:

Объект виджета

widgetAsync

(
  • containerId
  • name
  • path
  • options
)
Site3dWidget static

Defined in modules\widget\widget.js:9203

Метод асинхронного создания 3D виджета

Parameters:

  • containerId String

    Идентификатор HTML-контейнера

  • name String

    Имя модели

  • path String

    Путь до модели

  • options Site3dWidgetOptions

    Параметры виджета

Returns:

Site3dWidget:

Объект виджета как результат промиса

Properties

{string|(() => void)} url - Шаблон URL с `[path]` или функция «Скачать».

String

Defined in modules\widget\widget.js:6

Платформа, доступная для шеринга.

value - Код (value) выбранной настройки.

String

Defined in modules\widget\widget.js:13

Ссылка на настройку конфигуратора в окне метки.

{string} [animVariant] - Вариант анимации при показе.

Boolean

Defined in modules\widget\widget.js:19

Параметры сценария камеры при клике по метке.

{Site3dWidgetLabelMoveCameraOptions} [moveCamera] - Сценарий камеры по клику.

String

Defined in modules\widget\widget.js:32

Элемент списка options.labels.items (поверх дефолтов _labelItemInit).

{Object} [styles] - Стили блока меток.

Boolean

Defined in modules\widget\widget.js:54

Блок параметров меток виджета (options.labels).

value - Индекс трека анимации на модели.

Number

Defined in modules\widget\widget.js:62

Элемент массива номеров треков (animControl.number, hover.number, variants[].number).

{HTMLElement} [elem] - Созданный DOM узел метки.

String

Defined in modules\widget\widget.js:68

Метка на таймлайне анимации (animControl.marks, variants[].marks).

{number} [speed] - Скорость воспроизведения.

Site3dWidgetAnimControlNumberItem

Defined in modules\widget\widget.js:76

Параметры анимации для hover (animControl.hover).

{boolean} [commonSettings] - Если true — в getAnimOptions к базовому animControl подставляется только number варианта.

String

Defined in modules\widget\widget.js:84

Вариант анимации в панели (animControl.variants[]).

{boolean} [showPanel] - Показывать панель управления анимацией.

Boolean

Defined in modules\widget\widget.js:93

Блок options.animControl.

{number} [angleY] - Угол направления света по Y (градусы).

Number

Defined in modules\widget\widget.js:108

Элемент массива directionalLight / directionalLightUp / directionalLightAdditional (углы задаёт виджет).

{number} [opacity] - Непрозрачность слоя кисти (0…1).

Boolean

Defined in modules\widget\widget.js:115

Параметры кисти (options.painter.brush).

{Site3dWidgetPainterBrushOptions} brush - Параметры активной кисти.

Boolean

Defined in modules\widget\widget.js:122

Блок options.painter.

{Site3dWidgetPainterBrushOptions} [brush] - Слить параметры кисти.

Boolean

Defined in modules\widget\widget.js:129

Частичное обновление painter (аргумент {@link Site3dWidget#updatePainter}).

[isUpdateModel] - По умолчанию не `false` — вызывается `updateModelClicks`.

Boolean

Defined in modules\widget\widget.js:136

Опции вызова {@link Site3dWidget#updatePainter}.

{CSSStyleDeclaration} style - Стили элемента; {@link Site3dWidget#getLink} читает поле `navLink` на объекте стилей.

String

Defined in modules\widget\widget.js:142

Корневой DOM-элемент виджета: служебные поля при fullscreen; на style читают {@link Site3dWidget#getLink} — navLink.

[autoHide] - Автоскрытие панели навигации.

Boolean

Defined in modules\widget\widget.js:151

options.navControl

[url] - URL ссылки «поделиться» по умолчанию.

String

Defined in modules\widget\widget.js:157

options.navLink

{boolean} [autoStart] - Показывать при старте.

String

Defined in modules\widget\widget.js:163

options.navHelp (объект окна справки; false — отключить блок).

{boolean} [showPanels] - Показать панели.

Boolean

Defined in modules\widget\widget.js:170

options.navStart

[screenshots] - Доп. скриншоты в окне шеринга.

Site3dWidgetNavShareScreenshotItem

Defined in modules\widget\widget.js:183

options.navShare

{'start'|'hover'|string} [enabledTime] - Когда показывать.

Boolean

Defined in modules\widget\widget.js:189

options.logo

{number} [opacity] - Интенсивность (как в UI, 0…100).

Boolean

Defined in modules\widget\widget.js:196

options.watermark

{string} [caption] - Подпись.

Boolean

Defined in modules\widget\widget.js:204

options.preloadButton

{string} [axes] - Оси (`xy`, …).

Boolean

Defined in modules\widget\widget.js:211

options.moveControl

{number|undefined} [max] - Абсолютный максимум.

Boolean

Defined in modules\widget\widget.js:230

options.scaleControl

{number} [maxY] - Максимум по Y.

Boolean

Defined in modules\widget\widget.js:240

options.rotateControl

{number} [speed] - Скорость авто-вращения.

Boolean

Defined in modules\widget\widget.js:250

options.autoRotate

{boolean} [recalc] - Пересчёт при смене масштаба.

Boolean

Defined in modules\widget\widget.js:258

options.sizeControl

{'around'|'flick'|string} [type] - Тип / режим.

Boolean

Defined in modules\widget\widget.js:266

options.startRotate

[isEnabled] - Включить опцию.

Boolean

Defined in modules\widget\widget.js:273

options.startHelp

{*} [pos] - Служебное поле позиции (сбрасывается).

'perspective' | 'orthographic' | String

Defined in modules\widget\widget.js:279

options.camera (сливается в {@link Site3dWidget#updateCamera} / cameraSetup).

{number} [threshold] - Порог яркости bloom.

Boolean

Defined in modules\widget\widget.js:293

options.graphics.bloom

{number} [maxDistance] - SSAO: макс. дистанция (1…20).

Boolean

Defined in modules\widget\widget.js:302

options.graphics.ssao

{number} [opacity] - Прозрачность / сила эффекта.

Boolean

Defined in modules\widget\widget.js:311

options.graphics.ssr

{number} [b] - Синий канал (слайдер 0…10).

Number

Defined in modules\widget\widget.js:322

options.graphics.color (RGB-слайдеры UI, 0…10).

{number} [quality] - Качество рендера (0…100).

Boolean

Defined in modules\widget\widget.js:330

options.graphics.shadows

{number} [emissive] - Эмиссия PBR.

Boolean

Defined in modules\widget\widget.js:337

options.graphics.commonMaterial.physicalProperties

{Site3dWidgetGraphicsPhysicalProperties} [physicalProperties] - Подблок PBR общего материала.

Boolean

Defined in modules\widget\widget.js:346

options.graphics.commonMaterial

{number} [thickness] - Толщина линии / рёбер.

Boolean

Defined in modules\widget\widget.js:355

options.graphics.edges

[isEnabled] - Включить опцию.

Boolean

Defined in modules\widget\widget.js:364

options.graphics.optimize / screenSizeCorrection

{number} [minSquare] - Мин. площадь экрана для коррекции.

Boolean

Defined in modules\widget\widget.js:370

[fill] - Заливка окружения (`grey`, …).

String

Defined in modules\widget\widget.js:376

options.graphics.environment

{boolean} [autoCorrection] - Автокоррекция графики.

Number

Defined in modules\widget\widget.js:382

Блок options.graphics.

{Object<string, string>} [window] - Окно заказа.

Boolean

Defined in modules\widget\widget.js:402

Темизация (options.appearance): карты CSS-переменных по зонам.

{string} [part] - Имя части модели для ссылки.

Boolean

Defined in modules\widget\widget.js:411

Элемент options.links.items[] (база + {@link Site3dWidget#_linkItemInit}).

{Object<string, Object<string, string>>} [styles] - В т.ч. `hint` → карта CSS.

Site3dWidgetLinkItemOptions

Defined in modules\widget\widget.js:424

options.links

{string} [error] - Текст ошибки AR.

'quicklook' | String

Defined in modules\widget\widget.js:432

options.ar

{string} [path] - Путь к модели LOD.

Number | String

Defined in modules\widget\widget.js:448

Уровень options.lod.items[]

{Site3dWidgetLodLevelOptions[]} [items] - Уровни LOD.

Boolean

Defined in modules\widget\widget.js:455

options.lod

[caption] - Текст на кнопке формы.

String

Defined in modules\widget\widget.js:462

Кнопка формы заказа конфигуратора.

{Site3dWidgetConfiguratorOrderButtonOptions} [button] - Кнопка отправки формы.

Array<>

Defined in modules\widget\widget.js:468

Окно заказа options.configurator.orderInfo.window

{{ toEmail?: string }} [admin] - Настройки администратора заказа.

Boolean

Defined in modules\widget\widget.js:477

options.configurator.orderInfo

{string} [currency] - Символ валюты.

Boolean

Defined in modules\widget\widget.js:485

options.configurator.priceInfo

{number} [step] - Шаг слайдера оси.

Boolean

Defined in modules\widget\widget.js:494

Ось options.configurator.settingSize.axes.*

{string} [unit] - Единица размеров изделия.

Boolean

Defined in modules\widget\widget.js:504

options.configurator.settingSize

{boolean} [hideAfterSelect] - Скрывать панель после выбора.

String

Defined in modules\widget\widget.js:516

Блок options.configurator.

{string} [viewUrl] - База URL просмотра сохранённой сцены.

String

Defined in modules\widget\widget.js:536

Сервис сохранения ссылок (getLink / статистика).

{Site3dWidgetConfiguratorServiceOptions} [configuratorService] - Сервис ссылок/языка для {@link Site3dWidget#getLink}.

String

Defined in modules\widget\widget.js:549

Полные опции конструктора {@link Site3dWidget} (дефолты — optionsInit в конструкторе; внешний объект сливается через mergeObjects).

{boolean} [loaded] - Флаг «загрузка завершена» для колбэка статуса.

String

Defined in modules\widget\widget.js:617

Статус индикатора загрузки ({@link Site3dWidget#loadSetStatus}).

{boolean} [notUpdateRenderIsActive] - Не менять `isActive` у текущего рендера.

Boolean

Defined in modules\widget\widget.js:627

Доп. флаги {@link Site3dWidget#updateIsRender}.

{(info: { percent: number }) => void} [onProgress] - Колбэк прогресса POST.

'fullPath' | 'arPath' | String

Defined in modules\widget\widget.js:634

Параметры {@link Site3dWidget#saveFile}.

[texture] - URL, blob: или путь после сохранения на сервер.

String

Defined in modules\widget\widget.js:643

Настройка конфигуратора с текстурой (blob/url).

{boolean} [isOrder] - Пометить запрос как заказ.

String

Defined in modules\widget\widget.js:649

Аргумент {@link Site3dWidget#getLink}.

[cameraOptions] - То же, что в `options.camera` / снимке сцены.

Object

Defined in modules\widget\widget.js:656

Опции {@link Site3dWidget#getShareImageAsHTML}.

[start] - Вызов при старте сцены (учитывается только если коррекция включена).

Boolean

Defined in modules\widget\widget.js:662

Аргумент {@link Site3dWidget#updateScreenSizeCorrection}.

{boolean} [isAdditional] - Обновлять `directionalLightAdditional`.

Boolean

Defined in modules\widget\widget.js:668

Второй аргумент {@link Site3dWidget#updateDirectionalLight}.

[isUpdateModel] - После смены данных вызвать `updateModelClicks` и т.п.

Boolean

Defined in modules\widget\widget.js:675

Общие флаги merge-методов (updateLinks, updatePainter, …).

{string} [scaleMax] - Макс. дистанция зума для части модели.

String

Defined in modules\widget\widget.js:681

Опции {@link Site3dWidget#moveToModelPart}.

{string[]} [styles] - Дополнительные CSS-классы.

String

Defined in modules\widget\widget.js:691

Опции разметки кнопки навигации ({@link Site3dWidget#_getNavButtonAsString}).

{number} z - Смещение по Z в % от размера модели.

Number

Defined in modules\widget\widget.js:698

Коррекция позиции модели (проценты от размера).

{string[]} [exceptions] - Имена частей модели, которые скрыть на кадр.

String

Defined in modules\widget\widget.js:706

Параметры {@link Site3dWidget#exportImage}.

{boolean} [isWatermark] - Наложить водяной знак на запись.

String

Defined in modules\widget\widget.js:718

Параметры {@link Site3dWidget#exportVideo}.

{Object} initBrush - Исходные параметры материала для отката.

Boolean

Defined in modules\widget\widget.js:730

Служебные данные раскраски в material.userData.

} userData - userData three.js; в `painter` — состояние кисти.

painter?: Site3dWidgetPainterUserData

Defined in modules\widget\widget.js:737

Материал с расширенным userData для painter-режима.

delta - `[dx, dy]` в пикселях (как `mousePosDelta` в Site3d).

Number

Defined in modules\widget\widget.js:743

Второй аргумент {@link Site3d#callEvent} для имени dragMove (смещение указателя по осям).

info - Данные смещения drag (второй аргумент {@link Site3d#callEvent}).

Site3dWidgetDragMoveEventInfo | null

Defined in modules\widget\widget.js:749

DOM-событие dragMove от сцены Site3d: на Event добавлено поле info из {@link Site3d#callEvent}.

delta - Относительное изменение масштаба (знак и величина — как в Site3d).

Number

Defined in modules\widget\widget.js:755

Второй аргумент {@link Site3d#callEvent} для имени scale (щипок / масштаб жеста).

info - Данные жеста масштаба (второй аргумент {@link Site3d#callEvent}).

Site3dWidgetScaleGestureEventInfo | null

Defined in modules\widget\widget.js:761

DOM-событие scale от сцены Site3d.

{string} color - Цвет заливки пола (RGBA/HEX).

Boolean

Defined in modules\widget\widget.js:775

Блок options.floor.

[needRebuild] - Принудительно пересоздать геометрию пола.

Boolean

Defined in modules\widget\widget.js:784

Второй аргумент {@link Site3dWidget#updateFloor}.

{string} color - Цвет заливки skydome без текстуры.

Boolean

Defined in modules\widget\widget.js:790

Блок options.skybox.

[checkOther] - Если не `false`, переключить соседние панели из `_navButtonsCollection`.

Boolean

Defined in modules\widget\widget.js:800

Параметры для колбэков *ContentShow / *ContentHide / *ContentToggle.

container

Site3dWidgetContainerElement | Null

Defined in modules\widget\widget.js:1577

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

name

String

Defined in modules\widget\widget.js:1586

Свойство возвращает имя базовой модели виджета

guid

String

Defined in modules\widget\widget.js:1595

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

path

String

Defined in modules\widget\widget.js:1604

Свойство возвращает путь до базовой модели виджета

options

Site3dWidgetOptions

Defined in modules\widget\widget.js:1613

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

s3d

Site3d

Defined in modules\widget\widget.js:1622

Свойство возвращает объект сцены

model

(Site3dImportModel | Site3dCube) | Null

Defined in modules\widget\widget.js:1631

Свойство возвращает базовую модель виджета

isModelErrorLoad

Boolean

Defined in modules\widget\widget.js:1640

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

configurator

Site3dConfigurator | Null

Defined in modules\widget\widget.js:1649

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

isFull

Boolean

Defined in modules\widget\widget.js:1667

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

isRotate

Boolean

Defined in modules\widget\widget.js:1676

Свойство возвращает истину, если запущен режим вращения

isAnim

Boolean

Defined in modules\widget\widget.js:1685

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

isVR

Boolean

Defined in modules\widget\widget.js:1694

Свойство возвращает истину, если запущен режим VR

isAR

Boolean

Defined in modules\widget\widget.js:1703

Свойство возвращает истину, если запущен режим AR

isLod

Boolean

Defined in modules\widget\widget.js:1712

Свойство возвращает истину, если действует LOD

isConfiguratorData

Boolean

Defined in modules\widget\widget.js:1721

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

isConfigurator

Boolean

Defined in modules\widget\widget.js:1735

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

isLoad

Boolean

Defined in modules\widget\widget.js:1744

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

isLight

Boolean

Defined in modules\widget\widget.js:2305

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