API für die Interaktion mit dem Viewer.
Das Configurator 360-Viewer-Objekt enthält die API für die Interaktion mit dem Viewer.
Nur die Entfernen-Methode steht zur Verfügung, wenn dieses Objekt das Ergebnis eines Fehlers ist.
Entfernen Sie den Configurator 360-Viewer von der Seite.
Verwenden Sie das Objekt nach dem Entfernen des Viewers, nicht erneut.
Ruft die Eigenschaftswerte der Benutzeroberfläche für die geladene Konstruktion in einer Baumstruktur ab.
filter (optional => Vorgabe: ' ')
Typ: Zeichenfolge
Die refChain des Bauteils, für die Eigenschaften abgerufen werden sollen. Falls undefined, null oder eine leere Zeichenfolge (' '), werden die Aktionen aus dem Stamm angegeben.
callback (optional)
Typ: Rückmeldungsfunktion
result ist ein einfaches Objekt mit einer Struktur der Eigenschaften für das Bauteil und dessen untergeordnete Elemente in einer Anordnung.
Beispiele:
// 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 (optional)
Typ: Fehler-Rückmeldungsfunktion
Legt die Eigenschaftswerte der Benutzeroberfläche für die geladene Konstruktion fest.
properties (erforderlich)
Typ: Einfaches Objekt oder Anordnung von einfachen Objekten
Gibt die Eigenschaften an sowie die Werte, auf die sie festgelegt werden.
Beispiele:
// 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 (optional)
Typ: Rückmeldungsfunktion
result ist ein einfaches Objekt mit einer Struktur von mindestens den Eigenschaften, die von der Operation betroffen sind. Möglicherweise gibt es zusätzliche Eigenschaften, die nicht unbedingt geändert wurden. Das Ergebnis der Funktion getPropertyValues() für das Format finden Sie in den Beispielen
error (optional)
Typ: Fehler-Rückmeldungsfunktion
Aktiviert bzw. deaktiviert die automatische Aktualisierungsfunktion, über die die 3D-Ansicht automatisch aktualisiert wird, wenn sich die Eigenschaften ändern. Aktualisiert den Kontrollkästchenstatus und die Anzeige der Schaltfläche, die dem Element zugeordnet sind.
enable (erforderlich)
Typ: Boolescher Wert
True, um die automatische Aktualisierung zu aktivieren, False, um sie zu deaktivieren.
callback (optional)
Typ: Rückmeldungsfunktion
True, wenn die automatische Aktualisierung aktiviert ist, oder False, wenn sie deaktiviert ist.
error (optional)
Typ: Fehler-Rückmeldungsfunktion
Erzwingt die Aktualisierung der 3D-Ansicht durch den Viewer.
callback (optional)
Typ: Funktion
Wie Standard-Rückmeldungsfunktion, aber ohne Parameter
error (optional)
Typ: Fehler-Rückmeldungsfunktion
Ruft eine Liste der verfügbaren Aktionen für ein Bauteil ab.
data(optional = > Vorgabe: undefined)
Typ: Einfaches Objekt
Eingabeobjekt mit den folgenden Eigenschaften: Falls undefined, null oder eine leere Zeichenfolge (' '), werden die Aktionen aus dem Stamm angegeben.
refChain
Typ: Zeichenfolge
Gibt das Bauteil an, für das Aktionen abgerufen werden sollen.
callback (optional)
Typ: Rückmeldungsfunktion
Das Ergebnis ist eine Anordnung von einfachen Objekten mit den folgenden Eigenschaften:
category
Typ: Zeichenfolge
Kategoriename
displayName
Typ: Zeichenfolge
Der Anzeigename
name
Typ: Zeichenfolge
Interner Name der Aktion. Verwenden Sie diese Aktion, um programmatisch auf die Aktion zu verweisen, wie in executeAction.
error (optional)
Typ: Fehler-Rückmeldungsfunktion
Führt eine Aktion an einem Bauteil aus.
Für Ausgabeaktionen: Wenn kein Rückruf bereitgestellt wird, wird die erzeugte Datei vom Browser heruntergeladen. Andernfalls wird die Datei nicht automatisch heruntergeladen.
data (erforderlich)
Typ: Einfaches Objekt
Eingabeobjekt mit den folgenden Eigenschaften:
refChain (optional => Vorgabe: "Root")
Typ: Zeichenfolge
Gibt das Ziel-Bauteil an.
name (erforderlich)
Typ: Zeichenfolge
Gibt den Namen der Aktion an.
callback (optional)
Typ: Rückmeldungsfunktion
result hängt von der Art der ausgeführten Aktion ab:
- Für C360-Standardausgaben
Ein einfaches Objekt mit der folgenden Eigenschaft:
url
Typ: Zeichenfolge
Die URL der erstellten Ausgabe
- Für Aktionen, die die Eigenschaft ServerAction auf ReturnResult festlegen
Ein einfaches Objekt mit den folgenden Eigenschaften:
title
Typ: Zeichenfolge
Der Titel der Ausgabe, der vom Aktionscode festgelegt wird
message
Typ: Zeichenfolge
Die Meldung der Ausgabe, die vom Aktionscode festgelegt wird
- Für Aktionen, die die Eigenschaft ServerAction auf UpdateModel festlegen
Eine Struktur aus mindestens den Eigenschaften, die von der Operation betroffen waren. Möglicherweise gibt es zusätzliche Eigenschaften, die nicht unbedingt geändert wurden. Das Ergebnis der Funktion getPropertyValues() für das Format finden Sie in den Beispielen.
error (optional)
Typ: Fehler-Rückmeldungsfunktion
Speichert die Sitzung als IKMS-Datei. Wenn kein Rückruf bereitgestellt wird, wird die Datei vom Browser heruntergeladen. Andernfalls wird die Datei nicht automatisch heruntergeladen.
callback (optional)
Typ: Rückmeldungsfunktion
result ist ein einfaches Objekt mit den folgenden Eigenschaften:
urlTyp: Zeichenfolge
Die URL der erzeugten IKMS-Datei
Typ: Fehler-Rückmeldungsfunktion
Typ: Zahl
Gibt einen Code für den Status des Configurator 360-Viewers an.
Die Eigenschaften auf ADSK.C360.loadedState stehen für alle möglichen Werte.
Typ: Funktion (function (result) { })
Sofern definiert, wird die Rückmeldungsfunktion aufgerufen, wenn der Vorgang im Kontext des C360Viewer-Objekts mit dem Ergebnis des Vorgangs als einzigem Argument abgeschlossen wird.
Typ: Funktion (function (err) { })
Sofern definiert, wird die Rückmeldungsfunktion aufgerufen, wenn der Vorgang im Kontext des C360Viewer-Objekts mit dem Fehler-Objekt als einzigem Argument fehlschlägt.