Configurator 360 Viewer

API per l'interazione con il visualizzatore.

L'oggetto Configurator 360 Viewer contiene l'API per l'interazione con il visualizzatore.

È disponibile solo il metodo unload se questo oggetto è stato ottenuto in seguito a un errore.

unload()

Scaricare Configurator 360 Viewer dalla pagina.

Dopo aver scaricato il visualizzatore, non utilizzare nuovamente l'oggetto.

getPropertyValues(filter, callback, error)

I valori di proprietà dell'interfaccia utente per il progetto caricato vengono inseriti in una struttura ad albero.

filter (facoltativo => default: ' ')

Tipo: stringa

Il refChain della parte di cui ottenere le proprietà. Se undefined, null o stringa vuota (" "), vengono forniti i valori dal progetto principale.

callback (facoltativo)

Tipo: funzione di callback

result è un oggetto semplice con una struttura ad albero delle proprietà per la parte e i relativi elementi secondari in una serie.

Esempi:

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

Tipo: funzione Error Callback

setPropertyValues(properties, callback, error)

Imposta i valori di proprietà dell'interfaccia utente per il progetto caricato.

properties (obbligatorio)

Tipo: oggetto semplice o serie di oggetti semplici.

Consente di specificare le proprietà da impostare e per quali valori.

Esempi:

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

Tipo: funzione di callback

result è un oggetto semplice con una struttura ad albero almeno delle proprietà interessate dall'operazione. Potrebbero essere incluse altre proprietà che non sono state necessariamente modificate. Vedere gli esempi per il risultato della funzione getPropertyValues() per il formato

error (facoltativo)

Tipo: funzione Error Callback

enableAutoUpdate(enable, callback, error)

Consente di attivare o disattivare la funzione di aggiornamento automatico, con cui è possibile aggiornare automaticamente la vista 3D quando vengono modificate le proprietà. Aggiorna lo stato della casella di controllo e la visualizzazione del pulsante associato con la funzione.

enable (obbligatorio)

Tipo: booleano

true per abilitare gli aggiornamenti automatici, false per disabilitarli.

callback (facoltativo)

Tipo: funzione di callback

true quando l'aggiornamento automatico è abilitato o false quando è disabilitato.

error (facoltativo)

Tipo: funzione Error Callback

updateViewer(callback, error)

Forza il visualizzatore ad aggiornare la vista 3D.

callback (facoltativo)

Tipo: funzione

Uguale alla funzione di callback, ma senza parametri.

error (facoltativo)

Tipo: funzione Error Callback

getActions(data, callback, error)

Recupera un elenco delle azioni disponibili per una parte.

data(facoltativo => default: undefined)

Tipo: oggetto semplice

Oggetto di input contenente le seguenti proprietà. Se undefined, null o stringa vuota ("), fornisce azioni tratte dal progetto principale.

refChain

Tipo: stringa

Specifica la parte di destinazione per la quale ottenere le azioni.

callback (facoltativo)

Tipo: funzione di callback

result è un array di oggetti semplici con le seguenti proprietà:

category

Tipo: stringa

Nome categoria

displayName

Tipo: stringa

Il nome visualizzato

name

Tipo: stringa

Nome interno dell'azione. Utilizzare questa azione per fare riferimento all'azione a livello di programmazione come in executeAction.

error (facoltativo)

Tipo: funzione Error Callback

executeAction(data, callback, error)

Esegue un'azione su una parte.

Per le azioni di output: se non viene specificato un callback, il file generato viene scaricato dal browser. In caso contrario, il file non viene scaricato automaticamente.

data (obbligatorio)

Tipo: oggetto semplice

Oggetto di input contenente le seguenti proprietà.

refChain (facoltativo => default:"Root")

Tipo: stringa

Specifica la parte di destinazione.

name (obbligatorio)

Tipo: stringa

Specifica il nome dell'azione.

callback (facoltativo)

Tipo: funzione di callback

result dipende dal tipo di azione eseguita:

• Per output C360 standard

  Un oggetto semplice con la seguente proprietà:

  url

  Tipo: stringa

  L'URL dell'output generato

• Per le azioni che impostano la proprietà ServerAction su ReturnResult

  Un oggetto semplice con il seguente insieme di proprietà:

  title

  Tipo: stringa

  Il titolo del gruppo di output in base al codice azione

  message

  Tipo: stringa

  Il messaggio del gruppo di output in base al codice azione

• Per le azioni che impostano la proprietà ServerAction su UpdateModel

  Una struttura ad albero almeno delle proprietà interessate dall'operazione. Potrebbero essere incluse altre proprietà che non sono state necessariamente modificate. Vedere gli esempi per il risultato della funzione getPropertyValues() per il formato.

error (facoltativo)

Tipo: funzione Error Callback

save(callback, error)

Salva la sessione in un file IKMS. Se non viene specificato un callback, il file viene scaricato dal browser. In caso contrario, il file non viene scaricato automaticamente.

callback (facoltativo)

Tipo: funzione di callback

result è un oggetto semplice con la seguente proprietà:

url

Tipo: stringa

L'URL del file IKMS generato

error (facoltativo)

Tipo: funzione Error Callback

state

Tipo: numero

Specifica un codice che rappresenta lo stato di Configurator 360 Viewer.

Le proprietà su ADSK.C360.loadedState rappresentano tutti i valori possibili.

Funzione Callback

Tipo: funzione (funzione (risultato){ })

Se definita, la funzione Callback viene richiamata quando l'operazione viene completata nel contesto dell'oggetto C360Viewer con il risultato dell'operazione come unico argomento.

Funzione Error Callback

Tipo: funzione (function (err) { })

Se definita, la funzione Callback viene richiamata quando l'operazione non viene eseguita nel contesto dell'oggetto C360Viewer con l'oggetto Error come unico argomento.