57 lines
19 KiB
HTML
57 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><!-- use theme color or fallback -->
|
|
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
|
|
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../../nav.js"></script><script type="text/javascript" src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"></link><title>js.html.FileReader - API Reference</title><meta name="description" content="The <code><a href="../../js/html/FileReader.html">FileReader</a></code> object lets web applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer, using <code><a href="../../js/html/File.html">File</a></code> or <code><a href="../../js/html/Blob.html">Blob</a></code> objects to specify the file or data to read."/></head><body><style>
|
|
a, code .type {
|
|
color: #24afc4;
|
|
}
|
|
.navbar .brand {
|
|
display: inline-block;
|
|
float: none;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
|
|
background: #24afc4;
|
|
color: #ffffff;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
.navbar .container {
|
|
width: 940px ;
|
|
}
|
|
@media (max-width: 767px) {
|
|
.navbar .container {
|
|
width: auto;
|
|
}
|
|
}
|
|
@media (max-width: 979px) and (min-width: 768px) {
|
|
.navbar .container {
|
|
width: 724px;
|
|
}
|
|
}
|
|
@media (min-width: 1200px) {
|
|
.navbar .container {
|
|
width: 1170px;
|
|
}
|
|
}
|
|
.navbar .container img {
|
|
margin: 5px 0 0 4px;
|
|
}
|
|
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> FileReader</h1><h4><small>package <a href="../../js/html/index.html">js.html</a></small></h4><h4><small>extends <a class="type" title="EventTarget is an interface implemented by objects that can receive events and may have listeners for them." href="../../js/html/EventTarget.html">EventTarget</a></small></h4> <p class="availability"><hr/><em>Available on HTML5</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>The <code><a href="../../js/html/FileReader.html">FileReader</a></code> object lets web applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer, using <code><a href="../../js/html/File.html">File</a></code> or <code><a href="../../js/html/Blob.html">Blob</a></code> objects to specify the file or data to read.</p>
|
|
<p>Documentation <a href="https://developer.mozilla.org/en-US/docs/Web/API/FileReader">FileReader</a> by <a href="https://developer.mozilla.org/en-US/docs/Web/API/FileReader$history">Mozilla Contributors</a>, licensed under <a href="https://creativecommons.org/licenses/by-sa/2.5/">CC-BY-SA 2.5</a>.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://developer.mozilla.org/en-US/docs/Web/API/FileReader">https://developer.mozilla.org/en-US/docs/Web/API/FileReader</a></p></div></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3><p><code><a href="#new"><span class="identifier">new</span></a> ()</code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="error"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/FileReader.html#error"><span class="identifier">error</span></a>:<a class="type" title="The DOMError interface describes an error object that contains an error name." href="../../js/html/DOMError.html">DOMError</a></code></p></h3><div class="doc"><p>A <code><a href="../../js/html/DOMError.html">DOMError</a></code> representing the error that occurred while reading the file.</p></div></div><div class="field "><a name="onabort"></a><h3><p><code><a href="../../js/html/FileReader.html#onabort"><span class="identifier">onabort</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>A handler for the <code>abort</code> event. This event is triggered each time the reading operation is aborted.</p></div></div><div class="field "><a name="onerror"></a><h3><p><code><a href="../../js/html/FileReader.html#onerror"><span class="identifier">onerror</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>A handler for the <code>error</code> event. This event is triggered each time the reading operation encounter an error.</p></div></div><div class="field "><a name="onload"></a><h3><p><code><a href="../../js/html/FileReader.html#onload"><span class="identifier">onload</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>A handler for the <code>load</code> event. This event is triggered each time the reading operation is successfully completed.</p></div></div><div class="field "><a name="onloadend"></a><h3><p><code><a href="../../js/html/FileReader.html#onloadend"><span class="identifier">onloadend</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>A handler for the <code>loadend</code> event. This event is triggered each time the reading operation is completed (either in success or failure).</p></div></div><div class="field "><a name="onloadstart"></a><h3><p><code><a href="../../js/html/FileReader.html#onloadstart"><span class="identifier">onloadstart</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>A handler for the <code>loadstart</code> event. This event is triggered each time the reading is starting.</p></div></div><div class="field "><a name="onprogress"></a><h3><p><code><a href="../../js/html/FileReader.html#onprogress"><span class="identifier">onprogress</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>A handler for the <code>progress</code> event. This event is triggered while reading a <code><a href="../../js/html/Blob.html">Blob</a></code> content.</p></div></div><div class="field "><a name="readyState"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/FileReader.html#readyState"><span class="identifier">readyState</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><div class="doc"><p>A number indicating the state of the <code>FileReader</code>. This is one of the following:
|
|
<table class="standard-table"></p>
|
|
<p><tr>
|
|
<td><code>EMPTY</code></td>
|
|
<td><code>0</code></td>
|
|
<td>No data has been loaded yet.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>LOADING</code></td>
|
|
<td><code>1</code></td>
|
|
<td>Data is currently being loaded.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>DONE</code></td>
|
|
<td><code>2</code></td>
|
|
<td>The entire read request has been completed.</td>
|
|
</tr></p>
|
|
<p></table></p></div></div><div class="field "><a name="result"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/FileReader.html#result"><span class="identifier">result</span></a>:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="../../Dynamic.html">Dynamic</a></code></p></h3><div class="doc"><p>The file's contents. This property is only valid after the read operation is complete, and the format of the data depends on which of the methods was used to initiate the read operation.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="abort"></a><h3><p><code><a href="#abort"><span class="identifier">abort</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="readAsArrayBuffer"></a><h3><p><code><a href="#readAsArrayBuffer"><span class="identifier">readAsArrayBuffer</span></a> (<span style="white-space:nowrap">blob:<a class="type" title="A Blob object represents a file-like object of immutable, raw data." href="../../js/html/Blob.html">Blob</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="readAsBinaryString"></a><h3><p><code><a href="#readAsBinaryString"><span class="identifier">readAsBinaryString</span></a> (<span style="white-space:nowrap">filedata:<a class="type" title="A Blob object represents a file-like object of immutable, raw data." href="../../js/html/Blob.html">Blob</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="readAsDataURL"></a><h3><p><code><a href="#readAsDataURL"><span class="identifier">readAsDataURL</span></a> (<span style="white-space:nowrap">blob:<a class="type" title="A Blob object represents a file-like object of immutable, raw data." href="../../js/html/Blob.html">Blob</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="readAsText"></a><h3><p><code><a href="#readAsText"><span class="identifier">readAsText</span></a> (<span style="white-space:nowrap">blob:<a class="type" title="A Blob object represents a file-like object of immutable, raw data." href="../../js/html/Blob.html">Blob</a>,</span> <span style="white-space:nowrap">label:<a class="type" title="The basic String class." href="../../String.html">String</a> = ""</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="DONE"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <span class="label">read only</span><a href="../../js/html/FileReader.html#DONE"><span class="identifier">DONE</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a><span> = 2</span></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="EMPTY"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <span class="label">read only</span><a href="../../js/html/FileReader.html#EMPTY"><span class="identifier">EMPTY</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a><span> = 0</span></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="LOADING"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <span class="label">read only</span><a href="../../js/html/FileReader.html#LOADING"><span class="identifier">LOADING</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a><span> = 1</span></code></p></h3><div class="doc"><p></p></div></div></div> <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><div style="display:none"></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="EventTarget is an interface implemented by objects that can receive events and may have listeners for them." href="../../js/html/EventTarget.html">EventTarget</a></h4><div style="display:none"><div class="field "><a name="addEventListener"></a><h3><p><code><a href="#addEventListener"><span class="identifier">addEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p><p><code><a href="#addEventListener"><span class="identifier">addEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This method is called whenever an event occurs of the type for which the EventListener interface was registered." href="../../js/html/EventListener.html">EventListener</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false,</span> <span style="white-space:nowrap">?wantsUntrusted:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="dispatchEvent"></a><h3><p><code><a href="#dispatchEvent"><span class="identifier">dispatchEvent</span></a> (<span style="white-space:nowrap">event:<a class="type" title="The Event interface represents any event which takes place in the DOM; some are user-generated (such as mouse or keyboard events), while others are generated by APIs (such as events that indicate an animation has finished running, a video has been paused, and so forth)." href="../../js/html/Event.html">Event</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="removeEventListener"></a><h3><p><code><a href="#removeEventListener"><span class="identifier">removeEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p><p><code><a href="#removeEventListener"><span class="identifier">removeEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This method is called whenever an event occurs of the type for which the EventListener interface was registered." href="../../js/html/EventListener.html">EventListener</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">© 2017 <a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html> |