API de interacción con el visor.
El objeto Configurator 360 Viewer contiene la API para interactuar con el visor.
El método de descarga solo está disponible si este objeto se ha obtenido como resultado de un error.
Descargue Configurator 360 Viewer desde la página.
Después de descargar el visor, no utilice el objeto de nuevo.
Obtiene los valores de propiedad de la interfaz de usuario para el diseño cargado en una estructura de árbol.
filter (opcional => valor por defecto: ' ')
Tipo: cadena
El valor refChain de la pieza para la que desea obtener propiedades. Si el valor es undefined, null o una cadena vacía (' '), proporciona valores desde la raíz.
callback (opcional)
Tipo: función de llamada
El resultado es un objeto normal con una estructura de árbol de las propiedades de la pieza y sus hijos en una matriz.
Ejemplos:
// 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 (opcional)
Tipo: función de llamada de error
Define los valores de propiedad de la interfaz de usuario para el diseño cargado.
properties (obligatorio)
Tipo: objeto normal o matriz de objetos normales
Especifica las propiedades que se van a definir y a qué valores.
Ejemplos:
// 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 (opcional)
Tipo: función de llamada
El resultado es un objeto normal con una estructura de árbol de al menos las propiedades que se han visto afectadas por la operación. Puede haber otras propiedades que no fueron necesariamente cambiadas. Consulte los ejemplos a fin de ver el resultado de la función getPropertyValues() para el formato
error (opcional)
Tipo: función de llamada de error
Activa o desactiva la función de actualización automática, que se actualiza automáticamente en la vista 3D cuando las propiedades cambian. Actualiza el estado de la casilla de verificación y la visualización del botón asociado con la operación.
enable (obligatorio)
Tipo: booleano
true para activar las actualizaciones automáticas y false para desactivarlas.
callback (opcional)
Tipo: función de llamada
true si la actualización automática está activada o false si está desactivada.
error (opcional)
Tipo: función de llamada de error
Hace que el visor actualice la vista 3D.
callback (opcional)
Tipo: función
Igual que la función de llamada estándar, pero sin parámetros.
error (opcional)
Tipo: función de llamada de error
Permite obtener una lista de las acciones disponibles para una pieza.
data(opcional = > valor por defecto: undefined)
Tipo: objeto normal
Objeto de entrada que contiene las siguientes propiedades. Si el valor es undefined, null o una cadena vacía (''), proporciona acciones desde la raíz.
refChain
Tipo: cadena
Especifica la pieza objetivo para la que se van a obtener acciones.
callback (opcional)
Tipo: función de llamada
El resultado es una matriz de objetos normales con las siguientes propiedades:
category
Tipo: cadena
Nombre de la categoría
displayName
Tipo: cadena
Nombre para mostrar
name
Tipo: cadena
Nombre interno de la acción. Utilice esta acción para hacer referencia a la acción mediante programación como en executeAction.
error (opcional)
Tipo: función de llamada de error
Ejecuta una acción en una pieza.
Para acciones de salida: si no se proporciona ninguna llamada, el archivo se descarga mediante el navegador. De lo contrario, el archivo se descarga de manera automática.
data (obligatorio)
Tipo: objeto normal
Objeto de entrada que contiene las siguientes propiedades.
refChain (opcional => valor por defecto: "Root")
Tipo: cadena
Especifica la pieza objetivo.
name (obligatorio)
Tipo: cadena
Especifica el nombre de la acción.
callback (opcional)
Tipo: función de llamada
Resultado depende del tipo de acción ejecutada:
- Salidas estándar de C360
Un objeto normal con la propiedad siguiente:
url
Tipo: cadena
URL de la salida generada
- Para las acciones que definen la propiedad ServerAction en ReturnResult
Un objeto normal con el conjunto de propiedades siguiente:
title
Tipo: cadena
Título de la salida definida por el código de acción
message
Tipo: cadena
Mensaje de la salida definida por el código de acción
- Para las acciones que definen la propiedad ServerAction en UpdateModel
Una estructura de árbol que contenga al menos las propiedades que se han visto afectadas por la operación. Puede haber otras propiedades que no fueron necesariamente cambiadas. Consulte los ejemplos a fin de ver el resultado de la función getPropertyValues() correspondiente al formato.
error (opcional)
Tipo: función de llamada de error
Guarda la sesión en un archivo .ikms. Si no se proporciona ninguna llamada, el archivo se descarga mediante el navegador. De lo contrario, el archivo se descarga de manera automática.
callback (opcional)
Tipo: función de llamada
El resultado es un objeto normal con las siguientes propiedades:
urlTipo: cadena
La URL del archivo .ikms generado
Tipo: función de llamada de error
Tipo: número
Especifica un código que representa el estado de Configurator 360 Viewer.
La propiedades de ADSK.C360.loadedState representan todos los valores posibles.
Tipo: función (función (resultado) { })
Si se ha definido, la función de llamada que se invoca cuando finaliza la operación en el contexto del objeto de C360Viewer con el resultado de la operación como único argumento.
Tipo: función (función (error) { })
Si se ha definido, la función de llamada que se invoca cuando falla la operación en el contexto del objeto de C360Viewer con el objeto Error como único argumento.