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

loadShow

(
  • info
)

Defined in modules\widget\widget.js:837

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

Parameters:

  • info Object

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

loadHide

()

Defined in modules\widget\widget.js:852

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

loadSetStatus

(
  • info
)

Defined in modules\widget\widget.js:861

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

Parameters:

  • info Object

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

setRender

(
  • renderType
)

Defined in modules\widget\widget.js:895

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

Parameters:

  • renderType String

    Тип рендера

updateIsRender

(
  • value
  • options
)

Defined in modules\widget\widget.js:923

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

Parameters:

  • value Boolean

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

  • options Object

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

renderOn

()

Defined in modules\widget\widget.js:968

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

renderOff

()

Defined in modules\widget\widget.js:977

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

navButtonUpdate

(
  • name
  • isOn
)

Defined in modules\widget\widget.js:986

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

Parameters:

  • name String

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

  • isOn Boolean

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

navPanelsShow

()

Defined in modules\widget\widget.js:1018

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

navPanelsHide

()

Defined in modules\widget\widget.js:1036

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

navPanelsToggle

()

Defined in modules\widget\widget.js:1054

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

navSkyboxChange

(
  • value
)
async

Defined in modules\widget\widget.js:1070

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

Parameters:

  • value String

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

fullOn

()

Defined in modules\widget\widget.js:1091

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

fullOff

()

Defined in modules\widget\widget.js:1114

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

fullToggle

()

Defined in modules\widget\widget.js:1131

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

fullButtonKeyEvent

()

Defined in modules\widget\widget.js:1147

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

helpWindowShow

()

Defined in modules\widget\widget.js:1159

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

helpWindowHide

()

Defined in modules\widget\widget.js:1168

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

helpWindowToggle

()

Defined in modules\widget\widget.js:1177

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

rotateOn

()

Defined in modules\widget\widget.js:1186

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

rotateOff

()

Defined in modules\widget\widget.js:1223

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

rotateStop

()

Defined in modules\widget\widget.js:1234

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

rotateToggle

()

Defined in modules\widget\widget.js:1261

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

lightToggle

()

Defined in modules\widget\widget.js:1320

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

isCanAnim

() Boolean

Defined in modules\widget\widget.js:1329

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

Returns:

Boolean:

Результат

getAnimOptions

() Object

Defined in modules\widget\widget.js:1339

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

Returns:

Object:

Результат

getAnimNumber

(
  • number
)
Number[]

Defined in modules\widget\widget.js:1369

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

Parameters:

  • number Number[]

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

Returns:

Number[]:

Результат

animOn

()

Defined in modules\widget\widget.js:1385

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

animOff

()

Defined in modules\widget\widget.js:1448

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

animToggle

()

Defined in modules\widget\widget.js:1480

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

animScroll

(
  • delta
  • options
)

Defined in modules\widget\widget.js:1496

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

Parameters:

  • delta Number

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

  • options Object

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

animByEventOn

(
  • eventName
)

Defined in modules\widget\widget.js:1513

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

Parameters:

  • eventName String

    Имя события

animByEventOff

(
  • eventName
)

Defined in modules\widget\widget.js:1555

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

Parameters:

  • eventName String

    Имя события

animStop

()

Defined in modules\widget\widget.js:1574

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

animReset

()

Defined in modules\widget\widget.js:1596

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

animManualOn

()

Defined in modules\widget\widget.js:1611

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

animManualOff

()

Defined in modules\widget\widget.js:1628

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

animManualToggle

()

Defined in modules\widget\widget.js:1645

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

animShowMark

(
  • options
)

Defined in modules\widget\widget.js:1661

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

Parameters:

  • options Object

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

animRemoveMarks

(
  • marks
)

Defined in modules\widget\widget.js:1683

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

Parameters:

animClearMarksTimer

()

Defined in modules\widget\widget.js:1700

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

skyboxShow

() async

Defined in modules\widget\widget.js:1714

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

skyboxHide

() async

Defined in modules\widget\widget.js:1729

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

skyboxToggle

() async

Defined in modules\widget\widget.js:1744

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

sizeOn

()

Defined in modules\widget\widget.js:1761

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

sizeOff

()

Defined in modules\widget\widget.js:1809

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

sizeToggle

()

Defined in modules\widget\widget.js:1825

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

labelOn

()

Defined in modules\widget\widget.js:1841

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

labelOff

()

Defined in modules\widget\widget.js:1866

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

labelToggle

()

Defined in modules\widget\widget.js:1891

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

vrOn

()

Defined in modules\widget\widget.js:1907

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

vrOff

()

Defined in modules\widget\widget.js:1920

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

vrToggle

()

Defined in modules\widget\widget.js:1929

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

arOn

() Object async

Defined in modules\widget\widget.js:1953

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

Returns:

Object:

Результат

arOff

()

Defined in modules\widget\widget.js:2216

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

arToggle

() async

Defined in modules\widget\widget.js:2225

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

saveFile

(
  • category
  • blob
  • options
)
Promise async

Defined in modules\widget\widget.js:2250

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

Parameters:

  • category String

    Категория

  • blob Blob

    Данные файла

  • options Object

    Параметры

Returns:

Promise:

Результат

saveTextureFromObjectURL

(
  • texture
)
Promise async

Defined in modules\widget\widget.js:2310

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

Parameters:

  • texture String

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

Returns:

Promise:

Результат

saveSettingTexture

(
  • setting
)
async

Defined in modules\widget\widget.js:2328

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

Parameters:

  • setting Object

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

getShareImageAsHTML

(
  • options
)
Promise async

Defined in modules\widget\widget.js:2423

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

Parameters:

  • options Object

    Параметры

Returns:

Promise:

Результат

getShareDataAsHTML

() Promise async

Defined in modules\widget\widget.js:2455

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

Returns:

Promise:

Результат

getShareDataAsHTML

() Promise async

Defined in modules\widget\widget.js:2528

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

Returns:

Promise:

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

share

(
  • path
)
async

Defined in modules\widget\widget.js:2554

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

Parameters:

download

()

Defined in modules\widget\widget.js:2674

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

exportImage

(
  • options
)
Blob | null async

Defined in modules\widget\widget.js:2683

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

Parameters:

  • options Object

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

Returns:

Blob | null:

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

exportVideo

(
  • options
)
Blob | null async

Defined in modules\widget\widget.js:2752

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

Parameters:

  • options Object

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

Returns:

Blob | null:

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

appendNav

(
  • domElement
)

Defined in modules\widget\widget.js:2987

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

Parameters:

loadStyleString

(
  • elem
  • styleString
)
async

Defined in modules\widget\widget.js:2997

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

Parameters:

  • elem HTMLElement

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

  • styleString String

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

loadStyleFile

(
  • elem
  • path
  • fileName
)
async

Defined in modules\widget\widget.js:3025

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

Parameters:

  • elem HTMLElement

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

  • path String

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

  • fileName String

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

loadStyle

(
  • elem
  • category
  • value
)
async

Defined in modules\widget\widget.js:3045

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

Parameters:

  • elem HTMLElement

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

  • category String

    Категория

  • value String

    Значение

showNav

()

Defined in modules\widget\widget.js:3068

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

hideNav

()

Defined in modules\widget\widget.js:3083

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

updateTheme

(
  • value
)
async

Defined in modules\widget\widget.js:3116

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

Parameters:

  • value String

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

updateAppearance

(
  • value
)
async

Defined in modules\widget\widget.js:3139

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

Parameters:

  • value Object

    Значение

updateFontFamily

(
  • value
)
async

Defined in modules\widget\widget.js:3176

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

Parameters:

  • value String

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

updateBorderRadius

(
  • value
)

Defined in modules\widget\widget.js:3200

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

Parameters:

  • value Number

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

updateBackgroundColor

(
  • value
)

Defined in modules\widget\widget.js:3215

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

Parameters:

  • value String

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

updatePreloadBackgroundColor

(
  • value
)

Defined in modules\widget\widget.js:3230

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

Parameters:

  • value String

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

updatePreloadBackgroundImage

(
  • value
)

Defined in modules\widget\widget.js:3245

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

Parameters:

  • value String

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

updatePreloadPoster

(
  • value
)

Defined in modules\widget\widget.js:3263

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

Parameters:

  • value String

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

updatePreloadButton

(
  • value
)

Defined in modules\widget\widget.js:3279

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

Parameters:

  • value String

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

updateScaleFading

(
  • value
)

Defined in modules\widget\widget.js:3306

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

Parameters:

  • value Number

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

updateRotateFading

(
  • value
)

Defined in modules\widget\widget.js:3326

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

Parameters:

  • value Number

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

updatePosCorrection

(
  • value
)
async

Defined in modules\widget\widget.js:3346

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

Parameters:

  • value Object

    Параметры

updateSizeCorrection

(
  • value
)
async

Defined in modules\widget\widget.js:3389

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

Parameters:

  • value Number

    Значение

updateRotateCorrection

(
  • value
)
async

Defined in modules\widget\widget.js:3441

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

Parameters:

  • value Object

    Параметры

updateScaleControl

(
  • value
)

Defined in modules\widget\widget.js:3473

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

Parameters:

  • value Object

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

updateRotateControl

(
  • value
)

Defined in modules\widget\widget.js:3511

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

Parameters:

  • value Object

    Параметры

updateSizeControl

(
  • value
)

Defined in modules\widget\widget.js:3531

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

Parameters:

  • value Object

    Параметры

updateAmbientLight

(
  • value
)

Defined in modules\widget\widget.js:3553

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

Parameters:

  • value Object

    Параметры

updateDirectionalLight

(
  • value
  • options
)

Defined in modules\widget\widget.js:3573

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

Parameters:

  • value Object

    Параметры

  • options Object

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

updateDirectionalLights

()

Defined in modules\widget\widget.js:3611

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

updateGraphics

(
  • value
)

Defined in modules\widget\widget.js:3621

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

Parameters:

  • value Object

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

updateAnimControl

(
  • value
)

Defined in modules\widget\widget.js:3720

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

Parameters:

  • value Object

    Параметры

updateLod

() async

Defined in modules\widget\widget.js:3917

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

updateFloor

(
  • value
  • options
)
async

Defined in modules\widget\widget.js:3998

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

Parameters:

  • value Object

    Параметры

  • options Object

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

updateSkyboxModel

() async

Defined in modules\widget\widget.js:4073

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

updateSkybox

(
  • value
)
async

Defined in modules\widget\widget.js:4106

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

Parameters:

  • value Object

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

updateLabels

(
  • value
)
async

Defined in modules\widget\widget.js:4217

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

Parameters:

  • value Arrayobject

    Данные меток

updateConfigurator

(
  • value
)
async

Defined in modules\widget\widget.js:4682

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

Parameters:

  • value Object

    Параметры

updateConfiguratorInLabels

() async

Defined in modules\widget\widget.js:4857

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

updateScreenSizeCorrection

(
  • options
)

Defined in modules\widget\widget.js:4946

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

Parameters:

  • options Object

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

updateAr

(
  • value
)

Defined in modules\widget\widget.js:5163

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

Parameters:

  • value Object

    Данные AR

updateNavButtons

(
  • value
)
async

Defined in modules\widget\widget.js:5181

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

Parameters:

  • value Arraystring

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

updateFullButton

()

Defined in modules\widget\widget.js:5478

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

updateRotateButton

()

Defined in modules\widget\widget.js:5487

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

updateLightButton

()

Defined in modules\widget\widget.js:5496

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

updateAnimButton

()

Defined in modules\widget\widget.js:5505

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

updateSkyboxButton

()

Defined in modules\widget\widget.js:5581

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

updateHelp

(
  • value
)

Defined in modules\widget\widget.js:5603

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

Parameters:

  • value Object

    Значение

updateLabelButton

()

Defined in modules\widget\widget.js:5635

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

updateSizeButton

()

Defined in modules\widget\widget.js:5644

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

updateNavPanel

(
  • name
  • content
)

Defined in modules\widget\widget.js:5653

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

Parameters:

selectNavPanel

(
  • name
)

Defined in modules\widget\widget.js:5695

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

Parameters:

  • name String

    Имя панели

enableNavPanel

(
  • name
)

Defined in modules\widget\widget.js:5747

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

Parameters:

  • name String

    Имя панели

disableNavPanel

(
  • name
)

Defined in modules\widget\widget.js:5768

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

Parameters:

  • name String

    Имя панели

updateNavPanels

()

Defined in modules\widget\widget.js:5791

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

updateNavStart

(
  • value
)

Defined in modules\widget\widget.js:5820

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

Parameters:

  • value Object

    Значение

updateWatermark

(
  • value
)

Defined in modules\widget\widget.js:5904

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

Parameters:

  • value Object

    Параметры

updateStartRotate

(
  • value
)

Defined in modules\widget\widget.js:5929

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

Parameters:

  • value Object

    Параметры

stopStartRotate

()

Defined in modules\widget\widget.js:5942

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

updateStartHelp

(
  • value
)

Defined in modules\widget\widget.js:5955

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

Parameters:

  • value Object

    Параметры

stopStartHelp

()

Defined in modules\widget\widget.js:6032

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

updateAutoRotate

(
  • value
)

Defined in modules\widget\widget.js:6052

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

Parameters:

  • value Object

    Параметры

updateTargetControl

(
  • value
)

Defined in modules\widget\widget.js:6075

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

Parameters:

updateCamera

(
  • value
)

Defined in modules\widget\widget.js:6095

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

Parameters:

  • value Object

    Параметры

updateSizeInfo

()

Defined in modules\widget\widget.js:6163

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

updateNavShare

(
  • value
)

Defined in modules\widget\widget.js:6192

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

Parameters:

  • value Object

    Значение

moveToInitView

()

Defined in modules\widget\widget.js:6233

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

setStyles

(
  • name
  • styles
  • domElement
)

Defined in modules\widget\widget.js:6254

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

Parameters:

  • name String

    Имя

  • styles Object

    Стили

  • domElement HTMLElement

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

event

(
  • name
  • call
)

Defined in modules\widget\widget.js:6266

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

Parameters:

  • name String

    Имя события

  • call Function

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

removeEvent

(
  • name
  • call
)

Defined in modules\widget\widget.js:6277

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

Parameters:

  • name String

    Имя события

  • call Function

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

load

() async

Defined in modules\widget\widget.js:6288

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

saveConfiguratorStat

() async

Defined in modules\widget\widget.js:6849

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

getConfiguratorInfo

() Object

Defined in modules\widget\widget.js:6883

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

Returns:

Object:

Результат

clear

()

Defined in modules\widget\widget.js:6921

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

widget

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

Defined in modules\widget\widget.js:7042

Метод создания 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:7057

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

Parameters:

  • containerId String

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

  • name String

    Имя модели

  • path String

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

  • options Object

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

Returns:

Site3dWidget:

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

Properties

container

HTMLElement

Defined in modules\widget\widget.js:672

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

path

String

Defined in modules\widget\widget.js:682

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

path

String

Defined in modules\widget\widget.js:692

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

options

Object

Defined in modules\widget\widget.js:702

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

s3d

Site3d

Defined in modules\widget\widget.js:712

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

model

Site3dModel

Defined in modules\widget\widget.js:722

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

configurator

Site3dConfigurator

Defined in modules\widget\widget.js:732

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

isFull

Boolean

Defined in modules\widget\widget.js:742

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

isRotate

Boolean

Defined in modules\widget\widget.js:752

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

isAnim

Boolean

Defined in modules\widget\widget.js:762

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

isVR

Boolean

Defined in modules\widget\widget.js:772

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

isAR

Boolean

Defined in modules\widget\widget.js:782

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

isLod

Boolean

Defined in modules\widget\widget.js:792

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

isConfiguratorData

Boolean

Defined in modules\widget\widget.js:802

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

isConfigurator

Boolean

Defined in modules\widget\widget.js:817

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

isLoad

Boolean

Defined in modules\widget\widget.js:827

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

isLight

Boolean

Defined in modules\widget\widget.js:1299

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

isLight

Unknown

Defined in modules\widget\widget.js:1309

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