{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The content of this page is also included in the ZIP file as API_REFERENCE.md.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"API reference","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"uuid","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepted values","type":"text","marks":[{"type":"strong"}]},{"text":": Strings, e.g. ","type":"text"},{"text":"'b7a62e90-66f6-4aa8-b66c-4f90739f01a1'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Loads the 3D file associated with the specified UUID into the","type":"text"},{"type":"hardBreak"},{"text":"3D Viewer. The 3D file must have been uploaded to the 3YOURMIND server first,","type":"text"},{"type":"hardBreak"},{"text":"e.g. using ","type":"text"},{"text":"axios","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.npmjs.com/package/axios"}}]},{"text":" and ","type":"text"},{"text":"Vue","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"\n\n...\n\ndata() {\n return ({\n uuid: null,\n })\n},\n...\nmethods: {\n onUploadFile(event) {\n const file = event.target.files[0]\n const formData = new FormData()\n formData.append('file', file)\n axios\n .post('/api/v2.0/files/', formData, {\n headers: {\n 'content-type': 'multipart/form-data',\n },\n })\n .then((response) => {\n this.uuid = response.data.uuid\n })\n }\n}","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"uuidLoaded","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Event","type":"text"}]},{"type":"paragraph","content":[{"text":"Value","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"event.detail[0]","type":"text","marks":[{"type":"code"}]},{"text":" is an object containing the properties","type":"text"},{"type":"hardBreak"},{"text":"isSuccessful","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"uuid","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"message","type":"text","marks":[{"type":"code"}]},{"text":". The ","type":"text"},{"text":"message","type":"text","marks":[{"type":"code"}]},{"text":" can be ","type":"text"},{"text":"null","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Triggers when a file was loaded into the 3D Viewer, e.g.","type":"text"},{"type":"hardBreak"},{"text":"through a change of the ","type":"text"},{"text":"uuid","type":"text","marks":[{"type":"link","attrs":{"href":"#uuid"}}]},{"text":". The ","type":"text"},{"text":"message","type":"text","marks":[{"type":"code"}]},{"text":" property contains an error","type":"text"},{"type":"hardBreak"},{"text":"description if ","type":"text"},{"text":"isSuccessful","type":"text","marks":[{"type":"code"}]},{"text":" is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"url","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepted values","type":"text","marks":[{"type":"strong"}]},{"text":": Strings, e.g. ","type":"text"},{"text":"'","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Specifies the URL requests are sent to. This should be used to","type":"text"},{"type":"hardBreak"},{"text":"append an ","type":"text"},{"text":"Authorization","type":"text","marks":[{"type":"code"}]},{"text":" header to each request.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"parameter","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepted values","type":"text","marks":[{"type":"strong"}]},{"text":": Objects of the form:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n material: {\n minimumWallThickness: 0.2,\n optimalWallThickness: 0.5,\n },\n printer: {\n buildChamberBoundingBox: {\n width: 10.0,\n depth: 10.0,\n height: 10.0,\n }\n }\n}","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For ","type":"text"},{"text":"Vue","type":"text","marks":[{"type":"strong"}]},{"text":": Set the object using ","type":"text"},{"text":":parameter=\"JSON.stringify(parameter)","type":"text","marks":[{"type":"code"}]},{"text":",","type":"text"},{"type":"hardBreak"},{"text":"where ","type":"text"},{"text":"parameter","type":"text","marks":[{"type":"code"}]},{"text":" is an object of the form described above.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Sets printability parameter. Information about materials can be","type":"text"},{"type":"hardBreak"},{"text":"obtained from the 3YOURMIND server. See the","type":"text"},{"type":"hardBreak"},{"text":"API documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://app.3yourmind.com/apidocs/#operation/getMaterialList"}}]},{"type":"hardBreak"},{"text":"for more information. Example using ","type":"text"},{"text":"axios","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.npmjs.com/package/axios"}}]},{"type":"hardBreak"},{"text":"and ","type":"text"},{"text":"Vue","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"\n\n...\n\ndata() {\n return ({\n parameter: null,\n })\n},\n...\nmethods: {\n materialSelected() {\n axios\n .get('\n .then((response) => {\n const material = response.data[0]\n this.parameter = {\n material: {\n minimumWallThickness: material.minimumWallThickness,\n optimalWallThickness: material.optimalWallThickness,\n }\n }\n })\n }\n}","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"unit","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepted values","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"'mm'","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"'inch'","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"'cm'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Sets the unit of measurement. ","type":"text"},{"text":"Note","type":"text","marks":[{"type":"em"}]},{"text":": This is a","type":"text"},{"type":"hardBreak"},{"text":"two-way binding","type":"text","marks":[{"type":"link","attrs":{"href":"#Two-way-bindings"}}]},{"text":". The associated event is","type":"text"},{"type":"hardBreak"},{"text":"unitChanged","type":"text","marks":[{"type":"link","attrs":{"href":"#unitchanged"}}]},{"text":".","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"unitChanged","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Event","type":"text"}]},{"type":"paragraph","content":[{"text":"Value","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"event.detail[0]","type":"text","marks":[{"type":"code"}]},{"text":" is a string which can be one of the accepted values","type":"text"},{"type":"hardBreak"},{"text":"of ","type":"text"},{"text":"unit","type":"text","marks":[{"type":"link","attrs":{"href":"#unit"}}]}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Triggers when the user selects a different unit in the","type":"text"},{"type":"hardBreak"},{"text":"parameter panel.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"modelParameterChanged","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Event","type":"text"}]},{"type":"paragraph","content":[{"text":"Value","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"event.detail[0]","type":"text","marks":[{"type":"code"}]},{"text":" is an object of the form:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n \"width\": 33.26300048828125,\n \"height\": 56.83000183105469,\n \"depth\": 40.264007568359375,\n \"volume\": 21038.74609375,\n \"area\": 24143.220703125,\n \"boundingBoxVolume\": 76112.51825692593,\n \"numberOfFaces\": 412530\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Triggers when a different ","type":"text"},{"text":"uuid","type":"text","marks":[{"type":"link","attrs":{"href":"#uuidLoaded"}}]},{"text":" is loaded.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"features","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepted values","type":"text","marks":[{"type":"strong"}]},{"text":": Objects of the form:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n viewOptions: {\n wallThickness: false,\n supportStructure: true,\n perspective: true,\n xRay: true,\n wireFrame: true\n },\n printabilityOptions: {\n wallThickness: true,\n optimization: true,\n shells: true,\n buildChamber: false\n },\n parameterOptions: {\n unitToggle: true,\n dimension: true,\n volume: true,\n area: true,\n boxVolume: true,\n faces: true\n },\n downloadOptions: {\n original: true,\n optimized: true\n }\n}","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For ","type":"text"},{"text":"Vue","type":"text","marks":[{"type":"strong"}]},{"text":": Set the object using ","type":"text"},{"text":":features=\"JSON.stringify(features)","type":"text","marks":[{"type":"code"}]},{"text":", where","type":"text"},{"type":"hardBreak"},{"text":"features","type":"text","marks":[{"type":"code"}]},{"text":" is an object of the form described above.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Enables/Disables the specified features. Note that all features","type":"text"},{"type":"hardBreak"},{"text":"are enabled by default. In order to disable individual features, e.g. the wall","type":"text"},{"type":"hardBreak"},{"text":"thickness, it suffices to pass ","type":"text"},{"text":"{viewOptions: {wallThickness: false}}","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"options","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepted values","type":"text","marks":[{"type":"strong"}]},{"text":": Objects of the form:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n collapsedSidePanel: true,\n downloadFileName: 'Model Name'\n}","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For ","type":"text"},{"text":"Vue","type":"text","marks":[{"type":"strong"}]},{"text":": Set the object using ","type":"text"},{"text":":features=\"JSON.stringify(options)","type":"text","marks":[{"type":"code"}]},{"text":", where ","type":"text"},{"text":"options","type":"text","marks":[{"type":"code"}]},{"text":" is an object of the form described above.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Allows configuring settings for the 3D Viewer.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"ea549937-5ab9-4823-9e90-1c4a25a49522"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[153.0]},"content":[{"type":"paragraph","content":[{"text":"PROPERTY","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"DESCRIPTION","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[151.0]},"content":[{"type":"paragraph","content":[{"text":"TYPE","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[151.0]},"content":[{"type":"paragraph","content":[{"text":"ACCEPTED VALUES","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[151.0]},"content":[{"type":"paragraph","content":[{"text":"DEFAULT","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[153.0]},"content":[{"type":"paragraph","content":[{"text":"collapsedSidePanel","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Whether the Side Panel is collapsed or not at start up.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[151.0]},"content":[{"type":"paragraph","content":[{"text":"Boolean","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[151.0]},"content":[{"type":"paragraph","content":[{"text":"true, false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[151.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[153.0]},"content":[{"type":"paragraph","content":[{"text":"downloadFileName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[149.0]},"content":[{"type":"paragraph","content":[{"text":"Filename for files accessible through the Download tab.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[151.0]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[151.0]},"content":[{"type":"paragraph","content":[{"text":"any string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[151.0]},"content":[{"type":"paragraph","content":[{"text":"internal file ID","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"locale","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepted values","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"'en'","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"'de'","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"'fr'","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"'it'","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"'ja'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Sets the language.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"watchCssVars","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]},{"text":": Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"Accepted values","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"'true'","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"'false'","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]},{"text":": Enable/Disable watching of CSS custom property changes using","type":"text"}]},{"type":"paragraph","content":[{"text":"css-vars-ponyfill","type":"text","marks":[{"type":"link","attrs":{"href":"https://jhildenbiddle.github.io/css-vars-ponyfill/"}}]},{"text":" in old browsers.","type":"text"}]},{"type":"paragraph","content":[{"text":"Set to false if you are already using the same or a similar ponyfill.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Styling","type":"text"}]},{"type":"paragraph","content":[{"text":"Styling can be achieved through the use of CSS custom properties.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"css"},"content":[{"text":"threeyourmind-viewer-sdk {\n\t--primary-10: #eafaeb;\n\t--primary-50: #31de57;\n\t--primary-60: #2cc434;\n\t--primary-70: #26ab31;\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Custom styling is not supported for IE11.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Two way bindings","type":"text"}]},{"type":"paragraph","content":[{"text":"Each two-way bound attribute has a corresponding event. The binding should","type":"text"}]},{"type":"paragraph","content":[{"text":"therefore make sure to update the local property when the event fires. Example","type":"text"}]},{"type":"paragraph","content":[{"text":"Angular","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"paragraph","content":[{"text":"app.component.html","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html"},"content":[{"text":"\n","type":"text"}]},{"type":"paragraph","content":[{"text":"app.component.ts","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"ts"},"content":[{"text":"import { Component } from '@angular/core';\n\n@Component({\n templateUrl: './app.component.html',\n ...\n})\nexport class AppComponent {\n unit: string\n\n onUnitChanged(event) {\n // Hold on to the new unit to avoid overriding\n // when the component re-renders.\n // This is not necessary when only reacting\n // to the event.\n this.unit = event.detail[0]\n }\n}","type":"text"}]}],"version":1}

Browser not supported