API Docs for: 1.0.0
Show:

Site3dWidget Class

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

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

Constructor

Site3dWidget

(
  • containerId
  • name
  • path
  • options
)

Defined in modules\widget\widget.js:6

Parameters:

  • containerId String

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

  • name String

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

  • path String

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

  • options Object

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

Item Index

Methods

Properties

Methods

preloadShow

(
  • info
)

Defined in modules\widget\widget.js:1289

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

Parameters:

  • info Object

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

preloadHide

()

Defined in modules\widget\widget.js:1304

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

preloadSetStatus

(
  • info
)

Defined in modules\widget\widget.js:1313

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

Parameters:

  • info Object

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

setRender

(
  • renderType
)

Defined in modules\widget\widget.js:1346

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

Parameters:

  • renderType String

    Тип рендера

navButtonUpdate

(
  • name
  • isOn
)

Defined in modules\widget\widget.js:1376

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

Parameters:

  • name String

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

  • isOn Boolean

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

navPanelsShow

()

Defined in modules\widget\widget.js:1408

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

navPanelsHide

()

Defined in modules\widget\widget.js:1426

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

navPanelsToggle

()

Defined in modules\widget\widget.js:1444

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

navSkyboxChange

(
  • value
)
async

Defined in modules\widget\widget.js:1460

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

Parameters:

  • value String

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

fullOn

()

Defined in modules\widget\widget.js:1481

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

fullOff

()

Defined in modules\widget\widget.js:1504

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

fullToggle

()

Defined in modules\widget\widget.js:1521

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

fullButtonKeyEvent

()

Defined in modules\widget\widget.js:1537

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

helpWindowShow

()

Defined in modules\widget\widget.js:1549

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

helpWindowHide

()

Defined in modules\widget\widget.js:1558

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

helpWindowToggle

()

Defined in modules\widget\widget.js:1567

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

getRotateModel

() Site3dModel

Defined in modules\widget\widget.js:1576

Метод возвращает модель для вращения

Returns:

Site3dModel:

Результат

rotateOn

()

Defined in modules\widget\widget.js:1586

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

rotateOff

()

Defined in modules\widget\widget.js:1618

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

rotateStop

()

Defined in modules\widget\widget.js:1629

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

rotateToggle

()

Defined in modules\widget\widget.js:1656

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

lightToggle

()

Defined in modules\widget\widget.js:1715

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

isCanAnim

() Boolean

Defined in modules\widget\widget.js:1724

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

Returns:

Boolean:

Результат

getAnimOptions

() Object

Defined in modules\widget\widget.js:1734

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

Returns:

Object:

Результат

getAnimNumber

(
  • number
)
Number[]

Defined in modules\widget\widget.js:1764

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

Parameters:

  • number Number[]

    Номера анимации

Returns:

Number[]:

Результат

animOn

()

Defined in modules\widget\widget.js:1780

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

animOff

()

Defined in modules\widget\widget.js:1843

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

animToggle

()

Defined in modules\widget\widget.js:1875

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

animScroll

(
  • delta
  • options
)

Defined in modules\widget\widget.js:1891

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

Parameters:

  • delta Number

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

  • options Object

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

animByEventOn

(
  • eventName
)

Defined in modules\widget\widget.js:1908

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

Parameters:

  • eventName String

    Имя события

animByEventOff

(
  • eventName
)

Defined in modules\widget\widget.js:1950

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

Parameters:

  • eventName String

    Имя события

animStop

()

Defined in modules\widget\widget.js:1969

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

animReset

()

Defined in modules\widget\widget.js:1991

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

animManualOn

()

Defined in modules\widget\widget.js:2006

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

animManualOff

()

Defined in modules\widget\widget.js:2023

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

animManualToggle

()

Defined in modules\widget\widget.js:2040

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

animShowMark

(
  • options
)

Defined in modules\widget\widget.js:2056

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

Parameters:

  • options Object

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

animRemoveMarks

(
  • marks
)

Defined in modules\widget\widget.js:2078

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

Parameters:

animClearMarksTimer

()

Defined in modules\widget\widget.js:2095

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

skyboxShow

() async

Defined in modules\widget\widget.js:2109

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

skyboxHide

() async

Defined in modules\widget\widget.js:2124

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

skyboxToggle

() async

Defined in modules\widget\widget.js:2139

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

sizeOn

()

Defined in modules\widget\widget.js:2156

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

sizeOff

()

Defined in modules\widget\widget.js:2192

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

sizeToggle

()

Defined in modules\widget\widget.js:2208

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

labelOn

()

Defined in modules\widget\widget.js:2224

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

labelOff

()

Defined in modules\widget\widget.js:2249

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

labelToggle

()

Defined in modules\widget\widget.js:2274

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

vrOn

()

Defined in modules\widget\widget.js:2290

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

vrOff

()

Defined in modules\widget\widget.js:2303

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

vrToggle

()

Defined in modules\widget\widget.js:2312

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

arOn

() async

Defined in modules\widget\widget.js:2336

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

arOff

()

Defined in modules\widget\widget.js:2514

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

arToggle

() async

Defined in modules\widget\widget.js:2523

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

saveFile

(
  • category
  • blob
  • options
)
Promise async

Defined in modules\widget\widget.js:2548

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

Parameters:

  • category String

    Категория

  • blob Blob

    Данные файла

  • options Object

    Параметры

Returns:

Promise:

Результат

saveTextureFromObjectURL

(
  • texture
)
Promise async

Defined in modules\widget\widget.js:2608

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

Parameters:

  • texture String

    Ссылка на текстуру

Returns:

Promise:

Результат

saveSettingTexture

(
  • setting
)
async

Defined in modules\widget\widget.js:2626

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

Parameters:

  • setting Object

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

getShareImageAsHTML

(
  • options
)
Promise async

Defined in modules\widget\widget.js:2710

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

Parameters:

  • options Object

    Параметры

Returns:

Promise:

Результат

getShareDataAsHTML

() Promise async

Defined in modules\widget\widget.js:2743

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

Returns:

Promise:

Результат

getShareDataAsHTML

() Promise async

Defined in modules\widget\widget.js:2816

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

Returns:

Promise:

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

share

(
  • path
)
async

Defined in modules\widget\widget.js:2842

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

Parameters:

download

()

Defined in modules\widget\widget.js:2962

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

exportImage

(
  • options
)
Blob | null async

Defined in modules\widget\widget.js:2971

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

Parameters:

  • options Object

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

Returns:

Blob | null:

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

exportVideo

(
  • options
)
Blob | null async

Defined in modules\widget\widget.js:3037

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

Parameters:

  • options Object

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

Returns:

Blob | null:

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

appendNav

(
  • domElement
)

Defined in modules\widget\widget.js:3269

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

Parameters:

loadStyleString

(
  • elem
  • styleString
)
async

Defined in modules\widget\widget.js:3279

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

Parameters:

  • elem HTMLElement

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

  • styleString String

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

loadStyleFile

(
  • elem
  • path
  • fileName
)
async

Defined in modules\widget\widget.js:3307

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

Parameters:

  • elem HTMLElement

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

  • path String

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

  • fileName String

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

loadStyle

(
  • elem
  • category
  • value
)
async

Defined in modules\widget\widget.js:3327

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

Parameters:

  • elem HTMLElement

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

  • category String

    Категория

  • value String

    Значение

showNav

()

Defined in modules\widget\widget.js:3350

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

hideNav

()

Defined in modules\widget\widget.js:3364

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

updateTheme

(
  • value
)
async

Defined in modules\widget\widget.js:3396

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

Parameters:

  • value String

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

updateAppearance

(
  • value
)
async

Defined in modules\widget\widget.js:3419

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

Parameters:

  • value Object

    Значение

updateFontFamily

(
  • value
)
async

Defined in modules\widget\widget.js:3456

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

Parameters:

  • value String

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

updateBorderRadius

(
  • value
)

Defined in modules\widget\widget.js:3480

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

Parameters:

  • value Number

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

updateBackgroundColor

(
  • value
)

Defined in modules\widget\widget.js:3495

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

Parameters:

  • value String

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

updatePreloadBackgroundColor

(
  • value
)

Defined in modules\widget\widget.js:3510

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

Parameters:

  • value String

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

updatePreloadBackgroundImage

(
  • value
)

Defined in modules\widget\widget.js:3525

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

Parameters:

  • value String

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

updatePreloadPoster

(
  • value
)

Defined in modules\widget\widget.js:3543

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

Parameters:

  • value String

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

updateWatermark

(
  • value
)

Defined in modules\widget\widget.js:3558

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

Parameters:

  • value Object

    Параметры

updateNavButtons

(
  • value
)
async

Defined in modules\widget\widget.js:3583

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

Parameters:

  • value Arraystring

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

updateFullButton

()

Defined in modules\widget\widget.js:3872

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

updateRotateButton

()

Defined in modules\widget\widget.js:3881

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

updateLightButton

()

Defined in modules\widget\widget.js:3890

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

updateAnimButton

()

Defined in modules\widget\widget.js:3899

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

updateSkyboxButton

()

Defined in modules\widget\widget.js:3970

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

updateHelp

(
  • value
)

Defined in modules\widget\widget.js:3979

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

Parameters:

  • value Object

    Значение

updateLabelButton

()

Defined in modules\widget\widget.js:4011

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

updateSizeButton

()

Defined in modules\widget\widget.js:4020

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

updateSizeCorrection

(
  • value
)
async

Defined in modules\widget\widget.js:4029

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

Parameters:

  • value Number

    Значение

updateRotateCorrection

(
  • value
)
async

Defined in modules\widget\widget.js:4074

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

Parameters:

  • value Object

    Параметры

updateStartHelp

()

Defined in modules\widget\widget.js:4106

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

updateNavPanel

(
  • name
  • content
)

Defined in modules\widget\widget.js:4167

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

Parameters:

selectNavPanel

(
  • name
)

Defined in modules\widget\widget.js:4209

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

Parameters:

  • name String

    Имя панели

enableNavPanel

(
  • name
)

Defined in modules\widget\widget.js:4261

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

Parameters:

  • name String

    Имя панели

disableNavPanel

(
  • name
)

Defined in modules\widget\widget.js:4282

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

Parameters:

  • name String

    Имя панели

updateNavPanels

()

Defined in modules\widget\widget.js:4305

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

updateNavStart

(
  • value
)

Defined in modules\widget\widget.js:4334

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

Parameters:

  • value Object

    Значение

updateScaleControl

(
  • value
)

Defined in modules\widget\widget.js:4418

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

Parameters:

  • value Object

    Число или процент

updateScaleFading

(
  • value
)

Defined in modules\widget\widget.js:4451

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

Parameters:

  • value Number

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

updateRotateControl

(
  • value
)

Defined in modules\widget\widget.js:4466

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

Parameters:

  • value Object

    Параметры

updateAutoRotate

(
  • value
)

Defined in modules\widget\widget.js:4486

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

Parameters:

  • value Object

    Параметры

updateRotateFading

(
  • value
)

Defined in modules\widget\widget.js:4504

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

Parameters:

  • value Number

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

updateTargetControl

(
  • value
)

Defined in modules\widget\widget.js:4519

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

Parameters:

updateAnimControl

(
  • value
)

Defined in modules\widget\widget.js:4539

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

Parameters:

  • value Object

    Параметры

updateCamera

(
  • value
)

Defined in modules\widget\widget.js:4736

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

Parameters:

  • value Object

    Параметры

updateFloor

(
  • value
  • options
)
async

Defined in modules\widget\widget.js:4798

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

Parameters:

  • value Object

    Параметры

  • options Object

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

updateSkyboxModel

() async

Defined in modules\widget\widget.js:4870

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

updateSkybox

(
  • value
)
async

Defined in modules\widget\widget.js:4907

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

Parameters:

  • value Array

    Варианты панорамы

updateSizeInfo

(
  • value
)

Defined in modules\widget\widget.js:5018

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

Parameters:

  • value Object

    Параметры

updateSizeControl

(
  • value
)

Defined in modules\widget\widget.js:5035

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

Parameters:

  • value Object

    Параметры

updateAmbientLight

(
  • value
)

Defined in modules\widget\widget.js:5057

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

Parameters:

  • value Arrayobject

    Данные меток

updateAmbientLight

(
  • value
)

Defined in modules\widget\widget.js:5498

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

Parameters:

  • value Object

    Параметры

updateDirectionalLight

(
  • value
  • options
)

Defined in modules\widget\widget.js:5518

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

Parameters:

  • value Object

    Параметры

  • options Object

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

updateDirectionalLights

()

Defined in modules\widget\widget.js:5556

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

updateGraphics

(
  • value
)

Defined in modules\widget\widget.js:5566

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

Parameters:

  • value Object

    Настройки графики

updateScreenSizeCorrection

(
  • options
)

Defined in modules\widget\widget.js:5665

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

Parameters:

  • options Object

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

updateConfigurator

(
  • value
)
async

Defined in modules\widget\widget.js:5714

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

Parameters:

  • value Object

    Параметры

updateConfiguratorInLabels

() async

Defined in modules\widget\widget.js:5858

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

updateAr

(
  • value
)

Defined in modules\widget\widget.js:5999

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

Parameters:

  • value Object

    Данные AR

updatePriceInfo

(
  • value
)

Defined in modules\widget\widget.js:6142

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

Parameters:

  • value Object

    Значение

updateOrderInfo

(
  • value
)

Defined in modules\widget\widget.js:6164

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

Parameters:

  • value Object

    Значение

updateNavShare

(
  • value
)

Defined in modules\widget\widget.js:6186

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

Parameters:

  • value Object

    Значение

moveToInitView

()

Defined in modules\widget\widget.js:6227

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

setStyles

(
  • name
  • styles
  • domElement
)

Defined in modules\widget\widget.js:6248

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

Parameters:

  • name String

    Имя

  • styles Object

    Стили

  • domElement HTMLElement

    DOM элемент, определяющий область видимости стилей

event

(
  • name
  • call
)

Defined in modules\widget\widget.js:6260

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

Parameters:

  • name String

    Имя события

  • call Function

    Функция обработки события

removeEvent

(
  • name
  • call
)

Defined in modules\widget\widget.js:6271

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

Parameters:

  • name String

    Имя события

  • call Function

    Функция обработки события

clear

()

Defined in modules\widget\widget.js:6282

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

updateLod

() async

Defined in modules\widget\widget.js:6294

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

saveConfiguratorStat

() async

Defined in modules\widget\widget.js:6375

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

getConfiguratorInfo

() Object

Defined in modules\widget\widget.js:6409

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

Returns:

Object:

Результат

widget

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

Defined in modules\widget\widget.js:6556

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

Parameters:

  • containerId String

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

  • name String

    Имя модели

  • path String

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

  • options Object

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

Returns:

Site3dWidget:

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

widgetAsync

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

Defined in modules\widget\widget.js:6571

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

Parameters:

  • containerId String

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

  • name String

    Имя модели

  • path String

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

  • options Object

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

Returns:

Site3dWidget:

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

Properties

container

HTMLElement

Defined in modules\widget\widget.js:1127

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

path

String

Defined in modules\widget\widget.js:1137

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

path

String

Defined in modules\widget\widget.js:1147

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

options

Object

Defined in modules\widget\widget.js:1157

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

s3d

Site3d

Defined in modules\widget\widget.js:1167

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

model

Site3dModel

Defined in modules\widget\widget.js:1177

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

configurator

Site3dConfigurator

Defined in modules\widget\widget.js:1187

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

isFull

Boolean

Defined in modules\widget\widget.js:1197

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

isRotate

Boolean

Defined in modules\widget\widget.js:1207

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

isAnim

Boolean

Defined in modules\widget\widget.js:1217

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

isVR

Boolean

Defined in modules\widget\widget.js:1227

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

isAR

Boolean

Defined in modules\widget\widget.js:1237

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

isLod

Boolean

Defined in modules\widget\widget.js:1247

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

isConfiguratorData

Boolean

Defined in modules\widget\widget.js:1257

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

isConfigurator

Boolean

Defined in modules\widget\widget.js:1269

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

isLoad

Boolean

Defined in modules\widget\widget.js:1279

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

isLight

Boolean

Defined in modules\widget\widget.js:1694

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

isLight

Unknown

Defined in modules\widget\widget.js:1704

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