Visualiseur de Configurator 360

API permettant d'interagir avec le visualiseur.

L'objet Visualiseur de Configurator 360 contient l'API permettant d'interagir avec le visualiseur.

Seule la méthode de déchargement (unload) est disponible si cet objet est obtenu à la suite d'une erreur.

unload()

Permet de décharger le visualiseur de Configurator 360 à partir de la page.

Ne réutilisez pas l'objet une fois que le visualiseur est déchargé.

getPropertyValues(filter, callback, error)

Permet d'obtenir les valeurs des propriétés de l'interface utilisateur pour la conception chargée dans une arborescence.

filter (facultatif, par défaut : ' ')

Type : chaîne.

Valeur refChain de la pièce pour laquelle obtenir des propriétés. Si la valeur n'est pas définie, est nulle ou correspond à une chaîne vide (''), des valeurs issues de la structure racine sont fournies.

callback (facultatif)

Type : fonction de rappel.

result est un objet simple avec une arborescence des propriétés de la pièce et de ses enfants dans un réseau.

Exemples :

// 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 (facultatif)

Type : fonction de rappel d'erreur.

setPropertyValues(properties, callback, error)

Définit les valeurs des propriétés de l'interface utilisateur pour la conception chargée.

properties (obligatoire)

Type : objet simple ou réseau d'objets simples.

Spécifie les propriétés à définir et leur valeur.

Exemples :

// 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 (facultatif)

Type : fonction de rappel.

result est un objet simple avec une arborescence contenant des propriétés affectées par l'opération. Elle peut également contenir d'autres propriétés qui n'ont pas forcément été modifiées. Voir les exemples pour le résultat de la fonction getPropertyValues() pour le format

error (facultatif)

Type : fonction de rappel d'erreur.

enableAutoUpdate(enable, callback, error)

Active ou désactive la fonction de mise à jour automatique, qui permet de mettre automatiquement à jour la vue 3D en cas de modification des propriétés. Met à jour l'état de la case à cocher et l'affichage du bouton associé à la fonction.

enable (obligatoire)

Type : booléen.

Les mises à jour automatiques sont activées lorsque la valeur est définie sur true ; elles sont désactivées lorsqu'elle est définie sur false.

callback (facultatif)

Type : fonction de rappel.

La mise à jour automatique est activée lorsque la valeur est définie sur true ; elle est désactivée lorsqu'elle est définie sur false.

error (facultatif)

Type : fonction de rappel d'erreur.

updateViewer(callback, error)

Force le visualiseur à mettre à jour la vue 3D.

callback (facultatif)

Type : fonction.

Identique à la fonction de rappel standard, mais ne possède aucun paramètre.

error (facultatif)

Type : fonction de rappel d'erreur.

getActions(data, callback, error)

Extrait la liste des actions disponibles pour une pièce.

data (facultatif ; par défaut : undefined)

Type : objet simple.

Objet d'entrée contenant les propriétés suivantes. Si la valeur n'est pas définie, est nulle ou correspond à une chaîne vide (''), les actions issues de la structure racine sont fournies.

refChain

Type : chaîne.

Spécifie la pièce cible pour laquelle les actions doivent être extraites.

callback (facultatif)

Type : fonction de rappel.

result est un tableau d'objets simples avec les propriétés suivantes :

category

Type : chaîne.

Nom de la catégorie.

displayName

Type : chaîne.

Nom d'affichage.

name

Type : chaîne.

Nom interne de l'action. Utilisez cette action pour désigner l'action par programmation telle qu'elle figure dans executeAction.

error (facultatif)

Type : fonction de rappel d'erreur.

executeAction(data, callback, error)

Exécute une action sur une pièce.

Actions de sortie : si aucun rappel n'est fourni, le fichier généré est chargé dans le navigateur. Sinon, il n'est pas téléchargé automatiquement.

data (obligatoire)

Type : objet simple.

Objet d'entrée contenant les propriétés suivantes.

refChain (facultatif => default:"Root")

Type : chaîne.

Spécifie la pièce cible.

name (obligatoire)

Type : chaîne.

Spécifie le nom de l'action.

callback (facultatif)

Type : fonction de rappel.

La valeur result varie selon le type d'action exécuté :

• Pour les sorties standard Configurator 360

  Un objet simple avec les propriétés suivantes :

  url

  Type : chaîne.

  URL de la sortie générée.

• Pour les actions qui définissent la propriété ServerAction sur ReturnResult

  Un objet simple avec le jeu de propriétés suivant :

  title

  Type : chaîne.

  Titre de la sortie définie par le code d'action.

  message

  Type : chaîne.

  Message de la sortie définie par le code d'action.

• Pour les actions qui définissent la propriété ServerAction sur UpdateModel

  Une arborescence comprenant au moins les propriétés modifiées par l'opération. Elle peut également contenir d'autres propriétés qui n'ont pas forcément été modifiées. Voir les exemples liés au résultat de la fonction getPropertyValues() pour le format.

error (facultatif)

Type : fonction de rappel d'erreur.

save(callback, error)

Enregistre la session dans un fichier .ikms. Si aucun rappel n'est fourni, le fichier est téléchargé dans le navigateur. Sinon, il n'est pas téléchargé automatiquement.

callback (facultatif)

Type : fonction de rappel.

result est un objet simple comportant les propriétés suivantes :

url

Type : chaîne.

URL du fichier .ikms généré.

error (facultatif)

Type : fonction de rappel d'erreur.

state

Type : nombre.

Spécifie un code représentant l'état du visualiseur de Configurator 360.

Les propriétés associées à ADSK.C360.loadedState représentent toutes les valeurs possibles.

Fonction de rappel

Type : fonction (function (result) { })

Si elle est définie, la fonction de rappel est appelée lorsque l'opération se termine dans le contexte de l'objet C360Viewer, avec le résultat de l'opération comme seul argument.

Fonction de rappel d'erreur

Type : fonction (function (err) { })

Si elle est définie, la fonction de rappel est appelée lorsque l'opération échoue dans le contexte de l'objet C360Viewer avec l'objet incorrect comme seul argument.