2
0

utils_FileUtils.js.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: utils/FileUtils.js</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Source: utils/FileUtils.js</h1>
  17. <section>
  18. <article>
  19. <pre class="prettyprint source linenums"><code>/**
  20. * File utils is used to read and write files.
  21. *
  22. * Can be used alongside with object serialization to store and load objects from file.
  23. *
  24. * @class
  25. * @static
  26. */
  27. function FileUtils(){}
  28. /**
  29. * Read a local or remote file as text data.
  30. *
  31. * @param {string} fname Path or URL of the file being read.
  32. * @param {Function} onLoad onLoad callback receives the read data as parameter.
  33. * @param {Function} onError onError call is called when a error occurs while reading the file.
  34. */
  35. FileUtils.read = function(fname, onLoad, onError)
  36. {
  37. var file = new XMLHttpRequest();
  38. file.overrideMimeType("text/plain");
  39. file.open("GET", fname, true);
  40. if(onLoad !== undefined)
  41. {
  42. file.onload = function()
  43. {
  44. onLoad(file.response);
  45. };
  46. }
  47. if(onError !== undefined)
  48. {
  49. file.onerror = onError;
  50. }
  51. file.send(null);
  52. };
  53. /**
  54. * Write text to a file and automatically download it from blob storage.
  55. *
  56. * @method writeFile
  57. * @param {string} fname Path of the file to write.
  58. * @param {string} data Text data to be written to the file.
  59. */
  60. FileUtils.write = function(fname, data)
  61. {
  62. var blob = new Blob([data], {type:"octet/stream"});
  63. var download = document.createElement("a");
  64. download.download = fname;
  65. download.href = window.URL.createObjectURL(blob);
  66. download.style.display = "none";
  67. download.onclick = function()
  68. {
  69. document.body.removeChild(this);
  70. };
  71. document.body.appendChild(download);
  72. download.click();
  73. };
  74. /**
  75. * Open file chooser dialog window for the user to select files stored in the system.
  76. *
  77. * The files selected are retrieved using the onLoad callback that receives a array of File objects.
  78. *
  79. * @param {Function} onLoad onLoad callback that receives array of files as parameter.
  80. * @param {string} filter File type filter (e.g. ".zip,.rar, etc)
  81. */
  82. FileUtils.select = function(onLoad, filter)
  83. {
  84. var chooser = document.createElement("input");
  85. chooser.type = "file";
  86. chooser.style.display = "none";
  87. document.body.appendChild(chooser);
  88. if(filter !== undefined)
  89. {
  90. chooser.accept = filter;
  91. }
  92. chooser.onchange = function(event)
  93. {
  94. if(onLoad !== undefined)
  95. {
  96. onLoad(chooser.files);
  97. }
  98. document.body.removeChild(chooser);
  99. };
  100. chooser.click();
  101. };
  102. export {FileUtils};
  103. </code></pre>
  104. </article>
  105. </section>
  106. </div>
  107. <nav>
  108. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnimationTimer.html">AnimationTimer</a></li><li><a href="BarGraph.html">BarGraph</a></li><li><a href="BezierCurve.html">BezierCurve</a></li><li><a href="Box.html">Box</a></li><li><a href="Box2.html">Box2</a></li><li><a href="BoxMask.html">BoxMask</a></li><li><a href="Circle.html">Circle</a></li><li><a href="ColorStyle.html">ColorStyle</a></li><li><a href="DOM.html">DOM</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="FileUtils.html">FileUtils</a></li><li><a href="Gauge.html">Gauge</a></li><li><a href="GradientColorStop.html">GradientColorStop</a></li><li><a href="GradientStyle.html">GradientStyle</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Helpers.html">Helpers</a></li><li><a href="Image.html">Image</a></li><li><a href="Key.html">Key</a></li><li><a href="Line.html">Line</a></li><li><a href="LinearGradientStyle.html">LinearGradientStyle</a></li><li><a href="Mask.html">Mask</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="MultiLineText.html">MultiLineText</a></li><li><a href="Node.html">Node</a></li><li><a href="NodeConnector.html">NodeConnector</a></li><li><a href="NodeGraph.html">NodeGraph</a></li><li><a href="NodeSocket.html">NodeSocket</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Path.html">Path</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="PatternStyle.html">PatternStyle</a></li><li><a href="PieChart.html">PieChart</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="QuadraticCurve.html">QuadraticCurve</a></li><li><a href="RadialGradientStyle.html">RadialGradientStyle</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="RoundedBox.html">RoundedBox</a></li><li><a href="ScatterGraph.html">ScatterGraph</a></li><li><a href="Style.html">Style</a></li><li><a href="Text.html">Text</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="Viewport.html">Viewport</a></li><li><a href="ViewportControls.html">ViewportControls</a></li></ul><h3>Global</h3><ul><li><a href="global.html#writeFile">writeFile</a></li></ul>
  109. </nav>
  110. <br class="clear">
  111. <footer>
  112. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sat Sep 17 2022 14:24:36 GMT+0100 (Hora de verão da Europa Ocidental)
  113. </footer>
  114. <script> prettyPrint(); </script>
  115. <script src="scripts/linenumber.js"> </script>
  116. </body>
  117. </html>