3dmol

<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><meta name="Author" content="David Koes & 3Dmoljs Contributors"><meta name="Description" content="A modern, object-oriented JavaScript library for visualizing molecular data"><title>Source: ui/form.js</title><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><style>article ul li{list-style:disc}</style><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">3Dmol.js</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="mei5HJjYKLn6aua5Z5PM5"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="$3Dmol.Label.html">Label</a></div><div class="sidebar-section-children"><a href="$3Dmol.StateManager.html">StateManager</a></div><div class="sidebar-section-children"><a href="$3Dmol.UI.html">UI</a></div><div class="sidebar-section-children"><a href="Color.html">Color</a></div><div class="sidebar-section-children"><a href="CustomLinear.html">CustomLinear</a></div><div class="sidebar-section-children"><a href="Cylinder.html">Cylinder</a></div><div class="sidebar-section-children"><a href="GLModel.html">GLModel</a></div><div class="sidebar-section-children"><a href="GLShape.html">GLShape</a></div><div class="sidebar-section-children"><a href="GLShape_GLShape.html">GLShape</a></div><div class="sidebar-section-children"><a href="GLViewer.html">GLViewer</a></div><div class="sidebar-section-children"><a href="GLVolumetricRender.html">GLVolumetricRender</a></div><div class="sidebar-section-children"><a href="Matrix3.html">Matrix3</a></div><div class="sidebar-section-children"><a href="Matrix4.html">Matrix4</a></div><div class="sidebar-section-children"><a href="Quaternion.html">Quaternion</a></div><div class="sidebar-section-children"><a href="ROYGB.html">ROYGB</a></div><div class="sidebar-section-children"><a href="RWB.html">RWB</a></div><div class="sidebar-section-children"><a href="Ray.html">Ray</a></div><div class="sidebar-section-children"><a href="Sinebow.html">Sinebow</a></div><div class="sidebar-section-children"><a href="Sphere.html">Sphere</a></div><div class="sidebar-section-children"><a href="Surface.html">Surface</a></div><div class="sidebar-section-children"><a href="Triangle.html">Triangle</a></div><div class="sidebar-section-children"><a href="Vector2.html">Vector2</a></div><div class="sidebar-section-children"><a href="Vector3.html">Vector3</a></div><div class="sidebar-section-children"><a href="VolumeData.html">VolumeData</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="kv4Yx5z0THf_b8XR4Gje1"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="GLDraw.html">GLDraw</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="ykThSufQWJcKGT1kXzr-A"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-code.html">Using 3Dmol within your code</a></div><div class="sidebar-section-children"><a href="tutorial-embeddable.html">Embedding a 3Dmol Viewer</a></div><div class="sidebar-section-children"><a href="tutorial-home.html">3Dmol Tutorials - Home</a></div><div class="sidebar-section-children"><a href="tutorial-learning_environment.html">Active Learning with 3Dmol.js</a></div><div class="sidebar-section-children"><a href="tutorial-url.html">Viewing Molecules with the 3Dmol Server</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="XcP4RUEg6tp7YKHbBVi9E"><div>Interfaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="AmbientOcclusionStyle.html">AmbientOcclusionStyle</a></div><div class="sidebar-section-children"><a href="ArrowSpec.html">ArrowSpec</a></div><div class="sidebar-section-children"><a href="AtomSelectionSpec.html">AtomSelectionSpec</a></div><div class="sidebar-section-children"><a href="AtomSpec.html">AtomSpec</a></div><div class="sidebar-section-children"><a href="AtomStyleSpec.html">AtomStyleSpec</a></div><div class="sidebar-section-children"><a href="BondStyle.html">BondStyle</a></div><div class="sidebar-section-children"><a href="BoxSpec.html">BoxSpec</a></div><div class="sidebar-section-children"><a href="CartoonStyleSpec.html">CartoonStyleSpec</a></div><div class="sidebar-section-children"><a href="ClickSphereStyleSpec.html">ClickSphereStyleSpec</a></div><div class="sidebar-section-children"><a href="CrossStyleSpec.html">CrossStyleSpec</a></div><div class="sidebar-section-children"><a href="CurveSpec.html">CurveSpec</a></div><div class="sidebar-section-children"><a href="CustomShapeSpec.html">CustomShapeSpec</a></div><div class="sidebar-section-children"><a href="CylinderSpec.html">CylinderSpec</a></div><div class="sidebar-section-children"><a href="DashedBondSpec.html">DashedBondSpec</a></div><div class="sidebar-section-children"><a href="FogSpec.html">FogSpec</a></div><div class="sidebar-section-children"><a href="IsoSurfaceSpec.html">IsoSurfaceSpec</a></div><div class="sidebar-section-children"><a href="LabelSpec.html">LabelSpec</a></div><div class="sidebar-section-children"><a href="LineSpec.html">LineSpec</a></div><div class="sidebar-section-children"><a href="LineStyleSpec.html">LineStyleSpec</a></div><div class="sidebar-section-children"><a href="OutlineStyle.html">OutlineStyle</a></div><div class="sidebar-section-children"><a href="ParserOptionsSpec.html">ParserOptionsSpec</a></div><div class="sidebar-section-children"><a href="ShapeSpec.html">ShapeSpec</a></div><div class="sidebar-section-children"><a href="SphereSpec.html">SphereSpec</a></div><div class="sidebar-section-children"><a href="SphereStyleSpec.html">SphereStyleSpec</a></div><div class="sidebar-section-children"><a href="StickStyleSpec.html">StickStyleSpec</a></div><div class="sidebar-section-children"><a href="SurfaceStyleSpec.html">SurfaceStyleSpec</a></div><div class="sidebar-section-children"><a href="UnitCellStyleSpec.html">UnitCellStyleSpec</a></div><div class="sidebar-section-children"><a href="ViewStyle.html">ViewStyle</a></div><div class="sidebar-section-children"><a href="ViewerGridSpec.html">ViewerGridSpec</a></div><div class="sidebar-section-children"><a href="ViewerSpec.html">ViewerSpec</a></div><div class="sidebar-section-children"><a href="VolumetricRendererSpec.html">VolumetricRendererSpec</a></div><div class="sidebar-section-children"><a href="WithinSelectionSpec.html">WithinSelectionSpec</a></div><div class="sidebar-section-children"><a href="global.html#XYZ">XYZ</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="jmKnIXRJjdjZ366ci7cdd"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#BCIF">BCIF</a></div><div class="sidebar-section-children"><a href="global.html#CAP">CAP</a></div><div class="sidebar-section-children"><a href="global.html#CDJSON">CDJSON</a></div><div class="sidebar-section-children"><a href="global.html#CIF">CIF</a></div><div class="sidebar-section-children"><a href="global.html#CUBE">CUBE</a></div><div class="sidebar-section-children"><a href="global.html#ColorSpec">ColorSpec</a></div><div class="sidebar-section-children"><a href="global.html#ColorschemeSpec">ColorschemeSpec</a></div><div class="sidebar-section-children"><a href="global.html#GRO">GRO</a></div><div class="sidebar-section-children"><a href="global.html#GradientSpec">GradientSpec</a></div><div class="sidebar-section-children"><a href="global.html#MMTFparser">MMTFparser</a></div><div class="sidebar-section-children"><a href="global.html#MOL2">MOL2</a></div><div class="sidebar-section-children"><a href="global.html#OFFSETS">OFFSETS</a></div><div class="sidebar-section-children"><a href="global.html#PDB">PDB</a></div><div class="sidebar-section-children"><a href="global.html#PQR">PQR</a></div><div class="sidebar-section-children"><a href="global.html#PRMTOP">PRMTOP</a></div><div class="sidebar-section-children"><a href="global.html#SDF">SDF</a></div><div class="sidebar-section-children"><a href="global.html#SurfaceType">SurfaceType</a></div><div class="sidebar-section-children"><a href="global.html#VASP">VASP</a></div><div class="sidebar-section-children"><a href="global.html#XYZ">XYZ</a></div><div class="sidebar-section-children"><a href="global.html#assignPDBBonds">assignPDBBonds</a></div><div class="sidebar-section-children"><a href="global.html#builtinColorSchemes">builtinColorSchemes</a></div><div class="sidebar-section-children"><a href="global.html#builtinGradients">builtinGradients</a></div><div class="sidebar-section-children"><a href="global.html#conversionMatrix3">conversionMatrix3</a></div><div class="sidebar-section-children"><a href="global.html#createViewer">createViewer</a></div><div class="sidebar-section-children"><a href="global.html#createViewerGrid">createViewerGrid</a></div><div class="sidebar-section-children"><a href="global.html#decode">decode</a></div><div class="sidebar-section-children"><a href="global.html#dic">dic</a></div><div class="sidebar-section-children"><a href="global.html#download">download</a></div><div class="sidebar-section-children"><a href="global.html#elementColors">elementColors</a></div><div class="sidebar-section-children"><a href="global.html#get">get</a></div><div class="sidebar-section-children"><a href="global.html#getColorFromStyle">getColorFromStyle</a></div><div class="sidebar-section-children"><a href="global.html#getbin">getbin</a></div><div class="sidebar-section-children"><a href="global.html#parseV3000">parseV3000</a></div><div class="sidebar-section-children"><a href="global.html#setSyncSurface">setSyncSurface</a></div><div class="sidebar-section-children"><a href="global.html#ssColors">ssColors</a></div><div class="sidebar-section-children"><a href="global.html#syncSurface">syncSurface</a></div><div class="sidebar-section-children"><a href="global.html#viewers">viewers</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://3dmol.org/doc/index.html" target="">Documentation</a></div><div class="navbar-item"><a id="" href="tutorial-home.html" target="">Tutorials</a></div><div class="navbar-item"><a id="" href="https://github.com/3dmol/3Dmol.js" target="_blank">GitHub</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">ui_form.js</h1></header><article><pre class="prettyprint source lang-js"><code>/** * This is a colection of contructor to make different input element * @function $3Dmol.UI#Form */ $3Dmol.UI.Form = (function () { /** * Create Color input * @function $3Dmol.UI#Form.Color * @param {Object} outerControl Reference object to store the value */ Form.Color = function (outerControl) { var redDot = $('<div></div>'); redDot.height(10); redDot.width(10); redDot.css('border-radius', '50%'); redDot.css('background', 'red'); redDot.css('margin-right', '3px'); var blueDot = redDot.clone(); blueDot.css('background', 'blue'); var greenDot = redDot.clone(); greenDot.css('background', 'green'); var control = this.control = { R: { value: 0, min: 0, max: 255, label: redDot }, G: { value: 0, min: 0, max: 255, label: greenDot }, B: { value: 0, min: 0, max: 255, label: blueDot }, }; var surroundingBox = this.ui = $('<div></div>') var boundingBox = $('<div></div>'); surroundingBox.append(boundingBox); var spectrumControl = { key: 'Spectrum', value: null } var spectrum = new Form.Checkbox(spectrumControl); boundingBox.append(spectrum.ui); spectrum.ui.css({ 'margin-left': '2px' }) var RValue = new Form.Slider(control.R); var GValue = new Form.Slider(control.G); var BValue = new Form.Slider(control.B); var sliders = $('<div></div>'); sliders.append(RValue.ui, GValue.ui, BValue.ui); var color = $('<div></div>'); boundingBox.append(sliders); boundingBox.append(color); // CSS RValue.slide.css('color', 'red'); // GValue.ui.css('display', 'block'); GValue.slide.css('color', 'green'); // BValue.ui.css('display', 'block'); BValue.slide.css('color', 'blue'); color.height(15); // color.width(50); color.css('margin-top', '6px'); color.css('margin-bottom', '6px'); color.css('border', '1px solid grey'); color.css('border-radius', '500px'); this.update = function () {}; var self = this; // Functionality function updatePreview() { var c = `rgb(${control.R.value}, ${control.G.value}, ${control.B.value})`; color.css('background', c); outerControl.value = c; self.update(control); } RValue.update = GValue.update = BValue.update = updatePreview; updatePreview(); spectrum.update = function (v) { sliders.toggle(); if (v.value) { color.css({ 'background': 'linear-gradient(to right, red, orange, yellow, green, blue, indigo, violet)' }); outerControl.value = 'spectrum'; } else { updatePreview(); } } this.getValue = function () { return outerControl; } this.validate = function () { return true; } this.setValue = function (colorValue) { if (colorValue == 'spectrum') { spectrum.setValue(true); spectrum.update(spectrumControl); sliders.hide(); outerControl.value = 'spectrum'; } } spectrum.ui.hide(); this.enableSpectrum = function () { spectrum.ui.show(); } } /** * Create ListInput input * @function $3Dmol.UI#Form.ListInput * @param {Object} control Reference object to store the value * @param {Array} listElements list of the elements through which options are generated */ Form.ListInput = function (control, listElements) { // var label = $('<div></div>'); // label.text(control.key); var surroundingBox = this.ui = $('<div></div>'); var boundingBox = $('<div></div>'); var itemList = listElements; // surroundingBox.append(label); surroundingBox.append(boundingBox); var select = $('<select></select>'); select.css($3Dmol.defaultCSS.ListInput.select); boundingBox.append(select); this.showAlertBox = true; var failMessage = $('<div></div>'); failMessage.text('Please select some value'); failMessage.css({ 'color': 'crimson', 'font-family': 'Arial', 'font-weight': 'bold', 'font-size': '10px' }); failMessage.hide(); boundingBox.append(failMessage); this.update = function () {} select.on('click', { parent: this }, (event) => { control.value = select.children('option:selected').val(); event.data.parent.update(control); }); this.getValue = () => { return control; } // this.preventAlertBox = function(){ // show // } this.validate = function () { if (control.value == 'select' || control.value == null) { (this.showAlertBox) ? failMessage.show(): null; select.css({ 'box-shadow': '0px 0px 2px red' }); return false; } else { failMessage.hide(); boundingBox.css({ 'box-shadow': 'none' }); return true; } } this.setValue = function (val) { if (listElements.indexOf(val) != -1) { select.empty(); var defaultOption = $('<option></option>'); defaultOption.text('select'); itemList.forEach((item) => { var option = $('<option></option>'); option.text(item); option.attr('value', item); select.append(option); if (val == item) { option.prop('selected', true); } }); control.value = select.children('option:selected').val(); } else { console.error('UI::Form::ListInput:incorrect value', val); } } this.updateList = function (newList) { select.empty(); var defaultOption = $('<option></option>'); defaultOption.text('select'); defaultOption.attr('value', 'select'); select.append(defaultOption); itemList = newList; itemList.forEach((item) => { var option = $('<option></option>'); option.text(item); option.attr('value', item); select.append(option); }); } this.updateList(itemList); } /** * Create text, numeric or range Input * @function $3Dmol.UI#Form.Input * @param {Object} control Reference object to store the value */ Form.Input = function (control) { var surroundingBox = this.ui = $('<div></div>'); var boundingBox = $('<div></div>'); // surroundingBox.append(label); surroundingBox.append(boundingBox); var validationType = this.validationType = 'text'; surroundingBox.css({ 'width': '100%', 'box-sizing': 'border-box' }) var input = this.domElement = $('<input type="text">'); boundingBox.append(input); var alertBox = $('<div></div>'); alertBox.css({ 'border': '1px solid darkred', 'border-radius': '3px', 'font-family': 'Arial', 'font-size': '10px', 'font-weight': 'bold', 'margin': '2px', 'margin-left': '4px', 'padding': '2px', 'color': 'darkred', 'background': 'lightcoral' }); var alertMessage = { 'invalid-input': 'Invalid input please check the value entered', } boundingBox.append(alertBox); alertBox.hide(); this.setWidth = function (width) { input.width(width - 6); } this.setWidth(75); input.css({ // 'margin-left': '4px' }); this.update = function () { } input.on('change', { parent: this, control: control }, (event) => { let inputString = input.val(); if (inputString[inputString.length - 1] == ',') { inputString = inputString.slice(0, -1); } if (validationType == 'range') { control.value = inputString.split(','); } else { control.value = inputString; } // calling update function event.data.parent.update(control); }); input.on('select', () => { // selectedText = input.val().substring(e.target.selectionStart, e.target.selectionEnd); }); this.getValue = () => { return control; } var error = this.error = function (msg) { alertBox.show(); alertBox.text(msg) } this.setValue = function (val) { if (validationType == 'range') { var text = val.join(','); input.val(text); } else { input.val(val); } control.value = val; } function checkInputFloat() { var inputString = input.val(); var dots = inputString.match(/\./g) || []; var checkString = inputString.replaceAll(/\./g, '').replaceAll(/[0-9]/g, ''); if (dots.length > 1) { return false } if (checkString != '') return false; if (isNaN(parseFloat(inputString))) { return false; } else { return true; } } function checkInputNumber() { var inputString = input.val(); var checkString = inputString.replaceAll(/[0-9]/g, ''); if (checkString != '') return false; if (isNaN(parseInt(inputString))) { return false; } else { return true; } } // Parse Input Range Functions // Checks only number, comma and hyphen present function checkRangeTokens(inputString) { var finalString = inputString.replaceAll(',', '').replaceAll('-', '').replaceAll(/[0-9]/g, '').replaceAll(' ', ''); if (finalString == '') return true; else return false; } function checkList(inputString) { inputString = inputString.replaceAll(' ', ''); if (inputString[inputString.length - 1] == ',') { inputString = inputString.slice(0, -1); } var rangeList = inputString.split(','); // If dublicate comma return false; if (/,,/g.exec(inputString)) return false; // If first element not a number return false; if (isNaN(parseInt(rangeList[0]))) return false; var validRangeList = rangeList.map((rangeInput) => { return checkRangeInput(rangeInput); }); return validRangeList.find((e) => { return e == false }) == undefined ? true : false; } function checkRangeInput(inputString) { var rangeInputs = inputString.split('-'); if (rangeInputs.length > 2) { return false; } else { if (rangeInputs.length == 0) { return true; } else if (rangeInputs.length == 1) { if (isNaN(parseInt(rangeInputs[0]))) return false; else return true; } else if (rangeInputs.length == 2) { if (isNaN(parseInt(rangeInputs[0])) || isNaN(parseInt(rangeInputs[1]))) return false; else return true; } else return false; } } var checkInput = this.checkInput = function () { var inputString = input.val(); if (validationType == 'number') { if (checkInputNumber()) { alertBox.hide(); return true; } else { error(alertMessage['invalid-input']); return false; } } else if (validationType == 'float') { if (checkInputFloat()) { alertBox.hide(); return true; } else { error(alertMessage['invalid-input']); return false; } } else if (validationType == 'range') { if (checkRangeTokens(inputString)) { if (checkList(inputString)) { alertBox.hide(); return true; } else { error(alertMessage['invalid-input']); return false; } } else { error(alertMessage['invalid-input']); return false; } } else { return true; } } this.validateOnlyNumber = function (floatType = false) { if (floatType) { validationType = 'float'; } else { validationType = 'number'; } input.on('keydown keyup paste cut', function () { checkInput(); }); } this.validateInputRange = function () { validationType = 'range'; input.on('keydown keyup paste cut', () => { checkInput(); }); } this.isEmpty = function () { if (control.value == "") { return true; } } this.validate = function () { if ((control.active == true && control.value != null && control.value != "" && checkInput()) || (control.active == false)) { input.css('box-shadow', 'none'); return true } else { input.css('box-shadow', '0px 0px 2px red'); return false; } } // CSS input.css($3Dmol.defaultCSS.Input.input); boundingBox.css($3Dmol.defaultCSS.Input.boundingBox); } /** * Create Checkbox input for boolean values * @function $3Dmol.UI#Form.Checkbox * @param {Object} control Reference object to store the value */ Form.Checkbox = function (control) { var label = $('<div></div>'); label.text(control.key); label.css($3Dmol.defaultCSS.TextDefault); var surroundingBox = this.ui = $('<div></div>'); var boundingBox = $('<div></div>'); surroundingBox.append(boundingBox); surroundingBox.append(label); var checkbox = $('<input type="checkbox" />'); boundingBox.append(checkbox); this.click = () => {}; this.update = function () { } this.getValue = () => { return control; } checkbox.on('click', { parent: this }, (event) => { control.value = checkbox.prop('checked'); event.data.parent.update(control); }); // CSS label.css('display', 'inline-block'); boundingBox.css('display', 'inline-block') this.validate = function () { return true; } this.setValue = function (val) { checkbox.prop('checked', val); this.update(control); control.value = val; } } /** * Create input for values between two numbers * @function $3Dmol.UI#Form.Slider * @param {Object} control Reference object to store the value */ Form.Slider = function (control) { var surroundingBox = this.ui = $('<div></div>'); var boundingBox = $('<div></div>'); surroundingBox.append(boundingBox); boundingBox.css('display', 'flex'); var slide = this.slide = $('<input type="range">'); slide.css('width', '100%'); var min = control.min || 0; var max = control.max || 100; var step = control.step || 1; var defaultValue = control.default || min; var labelContent = control.label || ''; var label = $('<div></div>'); label.append(labelContent); boundingBox.append(label); slide.attr('min', min); slide.attr('max', max); slide.attr('step', step); slide.attr('value', defaultValue); control.value = defaultValue; boundingBox.append(slide); var setValue = false; this.update = function () { }; this.getValue = () => { return control; } slide.on('mousedown', () => { setValue = true; }); slide.on('mousemove', { parent: this }, (event) => { if (setValue) { control.value = slide.val(); event.data.parent.update(control); } }); slide.on('mouseup', () => { setValue = false; }); // CSS boundingBox.css('align-items', 'center'); boundingBox.height('21px'); // boundingBox.css('border-radius', '2px'); // label.css('line-height', '21px'); slide.css('padding', '0px'); slide.css('margin', '0px'); this.validate = function () { return true; } this.setValue = function (val) { slide.val(val); control.value = slide.val(); } } /** * Create empty element used for property that whose input cannot be taken * @function $3Dmol.UI#Form.EmptyElement * @param {Object} control Reference object to store the value */ Form.EmptyElement = function (control) { this.ui = $('<div></div>'); this.onUpdate = () => { } this.getValue = () => { return control; } this.validate = function () { return true; } } // mainControl param will be used to take in specName // in the form of key // type will be 'form' // active will be used to activate deactivate form if more than one form /** * Creates Form input that takes input from different input element * * @function $3Dmol.UI#Form * @param {validSelectionSpec|validStyleSpec|validAtomSpec} specs the defination of spec is used as an input to generate the form * @param {Object} mainControl Reference of variable to store the value from the form */ function Form(specs, mainControl) { specs = specs || {}; var boundingBox = this.ui = $('<div></div>'); var heading = $('<div></div>'); heading.text(mainControl.key); // Styling heading heading.css({ 'border-bottom': '1px solid black', 'font-family': 'Arial', 'font-size': '14px', 'font-weight': 'bold', 'padding-top': '2px', 'padding-bottom': '4px' }); boundingBox.append(heading); boundingBox.addClass('form'); var inputs = this.inputs = []; // body.append(boundingBox); var keys = Object.keys(specs); keys.forEach((key) => { if (specs[key].gui) { var prop = new Property(key, specs[key].type); inputs.push(prop); boundingBox.append(prop.ui); } }); this.update = function () {} var update = () => { }; inputs.forEach((input) => { input.update = update; }) this.getValue = function () { mainControl.value = {}; inputs.forEach((input) => { var inputValue = input.getValue(); if (inputValue.active) { mainControl.value[inputValue.key] = inputValue.value; } }); return mainControl; } var updateValues = function (inputControl) { mainControl.value[inputControl.key] = mainControl.value; //control =? update(mainControl); } this.validate = function () { var validations = inputs.map((i) => { if (i.active.getValue().value) { return i.placeholder.validate(); } else { return true; } }); if (validations.find(e => e == false) == undefined) return true; else { return false; } } this.setValue = function (val) { var keys = Object.keys(val); for (var i = 0; i < keys.length; i++) { var input = inputs.find((e) => { if (e.control.key == keys[i]) return e; }); input.placeholder.setValue(val[keys[i]]); input.active.setValue(true); input.placeholder.ui.show(); input.control.active = true; } // mainControl.value = val; this.update(mainControl); this.getValue(); } this.getInputs = function () { return inputs; } function Property(key, type) { var control = this.control = { value: null, type: type, key: key, active: false }; var boundingBox = this.ui = $('<div></div>'); this.placeholder = { ui: $('<div></div>') }; // default value for ui element this.active = new Form.Checkbox({ value: false, key: key }); if (specs[key].type == 'string' || specs[key].type == 'element') { this.placeholder = new Form.Input(control); this.placeholder.ui.attr('type', 'text'); } else if (specs[key].type == 'number') { var slider = false; if (specs[key].min != undefined && specs[key].max != undefined && specs[key].default != undefined) { slider = true; } if (slider) { // if( specs[key].min && spec[key].max){ control.min = specs[key].min; control.max = specs[key].max; control.default = specs[key].default; control.step = specs[key].step || ((control.max - control.max) / 1000); this.placeholder = new Form.Slider(control); } else { this.placeholder = new Form.Input(control); this.placeholder.ui.attr('type', 'text'); this.placeholder.validateOnlyNumber(specs[key].floatType); } } else if (specs[key].type == 'array_range') { this.placeholder = new Form.Input(control); this.placeholder.ui.attr('type', 'text'); this.placeholder.validateInputRange(); } else if (specs[key].type == 'color') { this.placeholder = new Form.Color(control); if (specs[key].spectrum) { this.placeholder.enableSpectrum(); } } else if (specs[key].type == 'boolean') { this.placeholder = new Form.Checkbox(control); } else if (specs[key].type == 'properties') { this.placeholder = new Form.Input(control); this.placeholder.ui.attr('type', 'text'); } else if (specs[key].type == 'colorscheme') { this.placeholder = new Form.ListInput(control, Object.keys($3Dmol.builtinColorSchemes)); this.placeholder.ui.attr('type', 'text'); } else if (specs[key].type == undefined) { if (specs[key].validItems) { this.placeholder = new Form.ListInput(control, specs[key].validItems); } } else if (specs[key].type == 'form') { this.placeholder = new Form(specs[key].validItems, control); this.placeholder.ui.append($('<div></div>').css($3Dmol.defaultCSS.LinkBreak)); } else { this.placeholder = new Form.EmptyElement(control); // return new Form.EmptyElement(control); } this.getValue = function () { if (this.placeholder.getValue) return this.placeholder.getValue(); else return null; } // Adding active control for the property var placeholder = this.placeholder; if (type != 'boolean') { placeholder.ui.hide(); boundingBox.append(this.active.ui); this.active.update = function (c) { (c.value) ? placeholder.ui.show(): placeholder.ui.hide(); control.active = c.value; } } else { this.placeholder.update = function (c) { control.active = c.value; } } boundingBox.append(this.placeholder.ui); if (this.placeholder.onUpdate) this.placeholder.onUpdate(updateValues); } } return Form; })();</code></pre></article></section><footer class="footer" id="PeOAagUepe"><div class="wrapper">3Dmol.js © 2019-2024 | <a href="https://pitt.edu/" target="_blank">University of Pittsburgh</a> | <a href="https://github.com/3dmol/3Dmol.js/blob/master/LICENSE" target="_blank">License</a></div></footer></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">3Dmol.js</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://3dmol.org/doc/index.html" target="">Documentation</a></div><div class="navbar-item"><a id="" href="tutorial-home.html" target="">Tutorials</a></div><div class="navbar-item"><a id="" href="https://github.com/3dmol/3Dmol.js" target="_blank">GitHub</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="mei5HJjYKLn6aua5Z5PM5"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="$3Dmol.Label.html">Label</a></div><div class="sidebar-section-children"><a href="$3Dmol.StateManager.html">StateManager</a></div><div class="sidebar-section-children"><a href="$3Dmol.UI.html">UI</a></div><div class="sidebar-section-children"><a href="Color.html">Color</a></div><div class="sidebar-section-children"><a href="CustomLinear.html">CustomLinear</a></div><div class="sidebar-section-children"><a href="Cylinder.html">Cylinder</a></div><div class="sidebar-section-children"><a href="GLModel.html">GLModel</a></div><div class="sidebar-section-children"><a href="GLShape.html">GLShape</a></div><div class="sidebar-section-children"><a href="GLShape_GLShape.html">GLShape</a></div><div class="sidebar-section-children"><a href="GLViewer.html">GLViewer</a></div><div class="sidebar-section-children"><a href="GLVolumetricRender.html">GLVolumetricRender</a></div><div class="sidebar-section-children"><a href="Matrix3.html">Matrix3</a></div><div class="sidebar-section-children"><a href="Matrix4.html">Matrix4</a></div><div class="sidebar-section-children"><a href="Quaternion.html">Quaternion</a></div><div class="sidebar-section-children"><a href="ROYGB.html">ROYGB</a></div><div class="sidebar-section-children"><a href="RWB.html">RWB</a></div><div class="sidebar-section-children"><a href="Ray.html">Ray</a></div><div class="sidebar-section-children"><a href="Sinebow.html">Sinebow</a></div><div class="sidebar-section-children"><a href="Sphere.html">Sphere</a></div><div class="sidebar-section-children"><a href="Surface.html">Surface</a></div><div class="sidebar-section-children"><a href="Triangle.html">Triangle</a></div><div class="sidebar-section-children"><a href="Vector2.html">Vector2</a></div><div class="sidebar-section-children"><a href="Vector3.html">Vector3</a></div><div class="sidebar-section-children"><a href="VolumeData.html">VolumeData</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="kv4Yx5z0THf_b8XR4Gje1"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="GLDraw.html">GLDraw</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="ykThSufQWJcKGT1kXzr-A"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-code.html">Using 3Dmol within your code</a></div><div class="sidebar-section-children"><a href="tutorial-embeddable.html">Embedding a 3Dmol Viewer</a></div><div class="sidebar-section-children"><a href="tutorial-home.html">3Dmol Tutorials - Home</a></div><div class="sidebar-section-children"><a href="tutorial-learning_environment.html">Active Learning with 3Dmol.js</a></div><div class="sidebar-section-children"><a href="tutorial-url.html">Viewing Molecules with the 3Dmol Server</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="XcP4RUEg6tp7YKHbBVi9E"><div>Interfaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="AmbientOcclusionStyle.html">AmbientOcclusionStyle</a></div><div class="sidebar-section-children"><a href="ArrowSpec.html">ArrowSpec</a></div><div class="sidebar-section-children"><a href="AtomSelectionSpec.html">AtomSelectionSpec</a></div><div class="sidebar-section-children"><a href="AtomSpec.html">AtomSpec</a></div><div class="sidebar-section-children"><a href="AtomStyleSpec.html">AtomStyleSpec</a></div><div class="sidebar-section-children"><a href="BondStyle.html">BondStyle</a></div><div class="sidebar-section-children"><a href="BoxSpec.html">BoxSpec</a></div><div class="sidebar-section-children"><a href="CartoonStyleSpec.html">CartoonStyleSpec</a></div><div class="sidebar-section-children"><a href="ClickSphereStyleSpec.html">ClickSphereStyleSpec</a></div><div class="sidebar-section-children"><a href="CrossStyleSpec.html">CrossStyleSpec</a></div><div class="sidebar-section-children"><a href="CurveSpec.html">CurveSpec</a></div><div class="sidebar-section-children"><a href="CustomShapeSpec.html">CustomShapeSpec</a></div><div class="sidebar-section-children"><a href="CylinderSpec.html">CylinderSpec</a></div><div class="sidebar-section-children"><a href="DashedBondSpec.html">DashedBondSpec</a></div><div class="sidebar-section