与查看器进行交互的 API。
Configurator 360 查看器对象包含用于与查看器交互的 API。
如果由于出现错误获得该对象,则只有卸载方法可用。
从页面中卸载 Configurator 360 查看器。
卸载查看器后,请勿再使用该对象。
获取树状结构中已加载的设计的 UI 特性值。
filter(可选 => 默认:' ')
类型:字符串
要为其获得特性的部件的 refChain。如果为 undefined、null 或空字符串 (' '),则它会提供根中的值。
callback(可选)
类型:回调函数
结果是一个纯文本对象,包含部件以及数组中其子部件的特性的树状结构。
示例:
// 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(可选)
类型:错误回调函数
设置已加载设计的 UI 特性值。
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(可选)
类型:回调函数
结果是一个纯文本对象,包含至少受操作影响的特性的树状结构。可能还包含未必需要更改的其他特性。请参见 getPropertyValues() 函数的结果示例,以了解格式
error(可选)
类型:错误回调函数
启用或禁用自动更新功能,该功能可在特性更改时自动更新三维视图。更新复选框状态以及与该功能相关联的按钮的显示。
enable(必填)
类型:布尔型
“True”表示启用自动更新,“False”表示将其禁用。
callback(可选)
类型:回调函数
自动更新处于启用状态时为 True,处于禁用状态时则为 False。
error(可选)
类型:错误回调函数
强制查看器更新三维视图。
callback(可选)
类型:函数
与标准回调函数相同,但没有参数。
error(可选)
类型:错误回调函数
获取适用于零件的操作的列表。
data(可选 => 默认:未定义)
类型:纯文本对象
包含以下特性的输入对象。如果为 undefined、null 或空字符串 (' '),则它会提供根中的操作。
refChain
类型:字符串
指定要获取其相关操作的目标零件。
callback(可选)
类型:回调函数
结果是具有以下特性的纯文本对象数组:
category
类型:字符串
类别名称
displayName
类型:字符串
显示名称
name
类型:字符串
操作的内部名称。使用此操作可通过编程方式在 executeAction 中引用操作。
error(可选)
类型:错误回调函数
对零件执行操作。
对于输出操作:如果未提供回调,则生成的文件将由浏览器下载。否则,该文件不会自动下载。
data(必填)
类型:纯文本对象
包含以下特性的输入对象。
refChain(可选 => 默认值:“Root”)
类型:字符串
指定目标零件。
name(必填)
类型:字符串
指定该操作的名称。
callback(可选)
类型:回调函数
结果取决于执行的操作类型:
- 对于 C360 标准输出
具有以下特性的普通对象:
url
类型:字符串
生成的输出的 URL
- 对于将 ServerAction 特性设置为 ReturnResult 的操作
具有以下特性集的普通对象:
title
类型:字符串
由操作代码设置的输出的标题
message
类型:字符串
由操作代码设置的输出的消息
- 对于将 ServerAction 特性设置为 UpdateModel 的操作
该操作至少影响的特性的树状结构。可能还包含未必需要更改的其他特性。请参见 getPropertyValues() 函数的结果示例,以了解格式。
error(可选)
类型:错误回调函数
将会话保存在 .ikms 文件中。如果未提供回调,则文件将由浏览器下载。否则,该文件不会自动下载。
callback(可选)
类型:回调函数
结果是具有以下特性的纯文本对象:
url类型:字符串
生成的 .ikms 文件的 URL
类型:错误回调函数
类型:数字
指定表示 Configurator 360 查看器状态的代码。
ADSK.C360.loadedState 上的特性表示所有可能的值。
类型:函数(函数 (结果) { })
如果已定义,则在 C360Viewer 对象环境中完成操作且操作结果作为唯一的参数时,将调用该回调函数。
类型:函数(函数 (错误) { })。
如果已定义,则在 C360Viewer 对象环境中未能执行操作且错误对象作为唯一的参数时,将调用该回调函数。