Configurator 360 Viewer

API для взаимодействия со средством просмотра.

Объект Configurator 360 Viewer содержит API-интерфейс для взаимодействия со средством просмотра.

Если этот объект получен в результате ошибки, доступен только метод выгрузки.

unload()

Выгрузка Configurator 360 Viewer со страницы.

После выгрузки средства просмотра не следует использовать этот объект повторно.

getPropertyValues(filter, callback, error)

Получение значений свойств пользовательского интерфейса для загруженного проекта в структуре дерева.

filter (необязательно => по умолчанию: ' ')
Тип: строка
Объект refChain детали, для которого необходимо получить свойства. Если этот объект имеет значение undefined, нулевое значение или является пустой строкой (' '), то значения предоставляются из корневого объекта.
callback (необязательно)
Тип: функция обратного вызова
result — это простой объект с древовидной структурой свойств для детали и ее дочерних элементов в массиве.

Примеры: 

// Non-ETO/iLogic application
{
    "refChain": "Root",
    "properties": [
        {
            "name": "Tier",
            "value": "1 Tier"
        },
        {
            "name": "Casters",
            "value": false
        },
        {
            "name": "Total_Price",
            "value": "$700"
        }
    ]
}
// ETO application
{
  "refChain": "Root",
  "properties": [
    {
      "name": "uiCompany",
      "value": "[Enter Company]"
    },
    {
      "name": "uiTitle",
      "value": "[Enter Title]"
    }
  ],
  "children": [
    {
      "refChain": "Root.Cap",
      "properties": [
        {
          "name": "uiBOMPartNumber",
          "value": "Cap_15CN_NoIndicator_0_3_4"
        }
      ]
    },
    {
      "refChain": "Root.Bowl",
      "properties": [
        {
          "name": "uiBOMPartNumber",
          "value": "Bowl_15CN_Single_NoDrain"
        }
      ]
    }
  ]
}

error (необязательно)

Тип: ошибка функции обратного вызова

setPropertyValues(properties, callback, error)

Задание значений свойств пользовательского интерфейса для загруженного проекта.

properties (обязательно)
Тип: простой объект или массив простых объектов
Определение свойств, которые требуется задать, и их значений.

Примеры: 

// Set Properties prop1 and prop2 on the root part.
viewer.setPropertyValues({prop1: 5, prop2: 'some string'});
//Do the same with an array
viewer.setPropertyValues([{'name': 'prop1', 'value': 5}, {'name': 'prop2', 'value': 'some string'}]);
//Do the same with a tree structure
viewer.setPropertyValues({
	"refChain": "Root",
	"properties": [
		{
			'name': 'prop1',
			'value': 5
		},
		{
			'name': 'prop2',
			'value': 'some string'
		}
	],
	'children': [] // can include child parts with more properties to set
}]);
callback (необязательно)
Тип: функция обратного вызова
result — это простой объект с древовидной структурой свойств, которые меняются в результате операции. Возможно включение дополнительных свойств, которые не были изменены. См. примеры результата выполнения функции getPropertyValues() для определенных форматов.
error (необязательно)
Тип: ошибка функции обратного вызова

enableAutoUpdate(enable, callback, error)

Включение и отключение функции автоматического обновления, которая позволяет автоматически обновить 3D-вид при изменении свойств. Обновление статуса флажка и отображения кнопки, связанной с этой функцией.

enable(обязательно)
Тип: логическое значение
При выборе значения true автоматические обновления будут включены, при выборе значения false — отключены.
callback (необязательно)
Тип: функция обратного вызова
Если автоматическое обновление включено, выбирается значение true. Если отключено — false.
error (необязательно)
Тип: ошибка функции обратного вызова

updateViewer(callback, error)

Принудительное обновление 3D-вида в средстве просмотра.

callback (необязательно)
Тип: функция
Аналогично стандартной функция вызова, однако параметры отсутствуют.
error (необязательно)
Тип: ошибка функции обратного вызова

getActions(data, callback, error)

Получение списка доступных операций для детали.

data (необязательно => по умолчанию: не определено)

Тип: простой объект

Объект ввода, содержащий следующие свойства. Если этот объект имеет значение undefined, нулевое значение или является пустой строкой (''), то значения предоставляются из корневого объекта.

refChain
Тип: строка
Целевая деталь для выполнения операции.

callback (необязательно)

Тип: функция обратного вызова
result — это массив простых объектов со следующими свойствами:
category
Тип: строка
Имя категории
displayName
Тип: строка
Отображаемое имя
name
Тип: строка
Внутреннее имя действия. Используйте это действие для обращения к операции программным способом как в executeAction.

error (необязательно)

Тип: ошибка функции обратного вызова

executeAction(data, callback, error)

Применение операции к детали.

Для операций вывода: если обратный вызов не указан, созданный файл загружается с помощью браузера. В противном случае автоматическая загрузка файла не происходит.

data (обязательно)

Тип: простой объект
Объект ввода, содержащий следующие свойства:
refChain (необязательно => по умолчанию: "Root")
Тип: строка
Определение целевой детали.
name (обязательно)
Тип: строка
Определение имени операции.

callback (необязательно)

Тип: функция обратного вызова
result: зависит от типа выполняемой операции.
  • Для стандартных выводов C360

    Обычный объект со следующим свойством:

    url

    Тип: строка

    URL-адрес созданного выходного файла

  • Для операций, назначающих свойство ServerAction для ReturnResult

    Обычный объект со следующим набором свойств:

    title

    Тип: строка

    Название вывода, заданное кодом операции

    message

    Тип: строка

    Сообщение вывода, заданное кодом операции

  • Для операций, назначающих свойство ServerAction для UpdateModel

    Древовидная структура, в которую включаются как минимум свойства, изменяемые в результате этой операции. Возможно включение дополнительных свойств, которые не были изменены. См. примеры результата выполнения функции getPropertyValues() для определенных форматов.

error (необязательно)
Тип: ошибка функции обратного вызова

save(callback, error)

Сохранение сеанса в формате IKMS. Если обратный вызов не указан, файл загружается с помощью браузера. В противном случае автоматическая загрузка файла не происходит.

callback (необязательно)

Тип: функция обратного вызова

result — это простой объект со следующим свойством:

url

Тип: строка

URL-адрес созданного файла IKMS

error (необязательно)

Тип: ошибка функции обратного вызова

state

Тип: число

Определение кода, представляющего собой состояние Configurator 360 Viewer.

Свойства ADSK.C360.loadedState представляют все возможные значения.

Функция обратного вызова

Тип: функция (функция (результат) { })

Если этот тип определен, функция обратного вызова вызывается при завершении операции в контексте объекта С360Viewer. Результатом этой операции является единственный аргумент.

Ошибка функции обратного вызова

Тип: функция (функция (ошибка) { }).

Если этот тип определен, функция обратного вызова вызывается при сбое операции в контексте объекта С360Viewer. Результатом этой операции является единственный аргумент.

На уровень выше: Справочник по API

Ссылки, связанные с данной