UNPKG

@graphistry/js-upload-api

Version:

Graphistry upload client for reuse by node and browser clients

88 lines (86 loc) 67.4 kB
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>File | @graphistry/node-api - v5.1.3</title><meta name="description" content="Documentation for @graphistry/node-api - v5.1.3"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@graphistry/node-api - v5.1.3</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@graphistry/node-api - v5.1.3</a></li><li><a href="File.html">File</a></li></ul><h1>Class File </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead"> <a href="#file-examples" id="file-examples" style="color: inherit; text-decoration: none;"> <h1>File examples</h1> </a> </div><div><p><a href="File.html">File</a> objects are used for uploading data and then reusing as part of <a href="Dataset.html">Dataset</a> graph visualizations</p> <p>Powerfully, the same file may be reused in multiple <a href="Dataset.html">Dataset</a>s, so many variants can be made cheaply and quickly.</p> <p>For configuring supported file formats, see <a href="https://hub.graphistry.com/docs/api/2/rest/files/">https://hub.graphistry.com/docs/api/2/rest/files/</a> .</p> <br> <hr> <br> </div><dl class="tsd-comment-tags"><dt>example</dt><dd><p><strong>Upload an <a href="EdgeFile.html">EdgeFile</a> from a JSON object in a columnar form</strong></p> <pre><code class="language-javascript"><span class="hl-2">import</span><span class="hl-0"> { </span><span class="hl-3">EdgeFile</span><span class="hl-0"> } </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-1">&#39;@graphistry/node-api&#39;</span><span class="hl-0">;</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">edgesFile</span><span class="hl-0"> = </span><span class="hl-5">new</span><span class="hl-0"> </span><span class="hl-7">EdgeFile</span><span class="hl-0">(</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">&#39;s&#39;</span><span class="hl-3">:</span><span class="hl-0"> [</span><span class="hl-1">&#39;a&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;b&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;c&#39;</span><span class="hl-0">],</span><br/><span class="hl-0"> </span><span class="hl-1">&#39;d&#39;</span><span class="hl-3">:</span><span class="hl-0"> [</span><span class="hl-1">&#39;d&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;e&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;f&#39;</span><span class="hl-0">],</span><br/><span class="hl-0"> </span><span class="hl-1">&#39;v&#39;</span><span class="hl-3">:</span><span class="hl-0"> [</span><span class="hl-1">&#39;v1&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;v2&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;v3&#39;</span><span class="hl-0">]</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">);</span><br/><span class="hl-2">await</span><span class="hl-0"> </span><span class="hl-3">edgesFile</span><span class="hl-0">.</span><span class="hl-7">upload</span><span class="hl-0">(</span><span class="hl-3">client</span><span class="hl-0">);</span><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-1">`EdgeFile uploaded as ID </span><span class="hl-5">${</span><span class="hl-3">edgesFile</span><span class="hl-8">.</span><span class="hl-3">fileID</span><span class="hl-5">}</span><span class="hl-1">`</span><span class="hl-0">);</span> </code></pre> <br> </dd><dt>example</dt><dd><p><strong>Upload an <a href="EdgeFile.html">EdgeFile</a> from a JSON object in a row-oriented form</strong></p> <pre><code class="language-javascript"><span class="hl-2">import</span><span class="hl-0"> { </span><span class="hl-3">EdgeFile</span><span class="hl-0"> } </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-1">&#39;@graphistry/node-api&#39;</span><span class="hl-0">;</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">edgesFile</span><span class="hl-0"> = </span><span class="hl-5">new</span><span class="hl-0"> </span><span class="hl-7">EdgeFile</span><span class="hl-0">(</span><br/><span class="hl-0"> [</span><br/><span class="hl-0"> {</span><span class="hl-1">&#39;s&#39;</span><span class="hl-3">:</span><span class="hl-0"> </span><span class="hl-1">&#39;a&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;d&#39;</span><span class="hl-3">:</span><span class="hl-0"> </span><span class="hl-1">&#39;d&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;v&#39;</span><span class="hl-3">:</span><span class="hl-0"> </span><span class="hl-1">&#39;v1&#39;</span><span class="hl-0">},</span><br/><span class="hl-0"> {</span><span class="hl-1">&#39;s&#39;</span><span class="hl-3">:</span><span class="hl-0"> </span><span class="hl-1">&#39;b&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;d&#39;</span><span class="hl-3">:</span><span class="hl-0"> </span><span class="hl-1">&#39;e&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;v&#39;</span><span class="hl-3">:</span><span class="hl-0"> </span><span class="hl-1">&#39;v2&#39;</span><span class="hl-0">},</span><br/><span class="hl-0"> {</span><span class="hl-1">&#39;s&#39;</span><span class="hl-3">:</span><span class="hl-0"> </span><span class="hl-1">&#39;c&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;d&#39;</span><span class="hl-3">:</span><span class="hl-0"> </span><span class="hl-1">&#39;f&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;v&#39;</span><span class="hl-3">:</span><span class="hl-0"> </span><span class="hl-1">&#39;v3&#39;</span><span class="hl-0">}</span><br/><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-1">&#39;json&#39;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-1">&#39;my nodes file&#39;</span><span class="hl-0">,</span><br/><br/><span class="hl-0"> </span><span class="hl-4">// JSON parsing options:</span><br/><span class="hl-0"> </span><span class="hl-4">// - https://hub.graphistry.com/docs/api/2/rest/upload/data/#uploadjson2</span><br/><span class="hl-0"> </span><span class="hl-4">// - https://pandas.pydata.org/docs/reference/api/pandas.read_json.html</span><br/><span class="hl-0"> </span><span class="hl-4">//</span><br/><span class="hl-0"> </span><span class="hl-4">// Also: file_compression, sql_transforms, ...</span><br/><span class="hl-0"> </span><span class="hl-4">// https://hub.graphistry.com/docs/api/2/rest/files/</span><br/><span class="hl-0"> {</span><span class="hl-3">parser_options:</span><span class="hl-0"> {</span><span class="hl-3">orient:</span><span class="hl-0"> </span><span class="hl-1">&#39;records&#39;</span><span class="hl-0">}}</span><br/><br/><span class="hl-0">); </span><br/><span class="hl-2">await</span><span class="hl-0"> </span><span class="hl-3">edgesFile</span><span class="hl-0">.</span><span class="hl-7">upload</span><span class="hl-0">(</span><span class="hl-3">client</span><span class="hl-0">);</span><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-1">`EdgeFile uploaded as ID </span><span class="hl-5">${</span><span class="hl-3">edgesFile</span><span class="hl-8">.</span><span class="hl-3">fileID</span><span class="hl-5">}</span><span class="hl-1">`</span><span class="hl-0">);</span> </code></pre> <br> </dd><dt>example</dt><dd><p><strong>Upload an <a href="EdgeFile.html">EdgeFile</a> using promises</strong></p> <pre><code class="language-javascript"><span class="hl-2">import</span><span class="hl-0"> { </span><span class="hl-3">EdgeFile</span><span class="hl-0"> } </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-1">&#39;@graphistry/node-api&#39;</span><span class="hl-0">;</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">edgesFile</span><span class="hl-0"> = </span><span class="hl-5">new</span><span class="hl-0"> </span><span class="hl-7">EdgeFile</span><span class="hl-0">({</span><span class="hl-1">&#39;s&#39;</span><span class="hl-3">:</span><span class="hl-0"> [</span><span class="hl-1">&#39;a&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;b&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;c&#39;</span><span class="hl-0">], </span><span class="hl-1">&#39;d&#39;</span><span class="hl-3">:</span><span class="hl-0"> [</span><span class="hl-1">&#39;d&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;e&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;f&#39;</span><span class="hl-0">], </span><span class="hl-1">&#39;v&#39;</span><span class="hl-3">:</span><span class="hl-0"> [</span><span class="hl-1">&#39;v1&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;v2&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;v3&#39;</span><span class="hl-0">]});</span><br/><span class="hl-3">edgesFile</span><span class="hl-0">.</span><span class="hl-7">upload</span><span class="hl-0">(</span><span class="hl-3">client</span><span class="hl-0">).</span><span class="hl-7">then</span><span class="hl-0">(</span><br/><span class="hl-0"> () </span><span class="hl-5">=&gt;</span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-1">`EdgeFile uploaded as ID </span><span class="hl-5">${</span><span class="hl-3">edgesFile</span><span class="hl-8">.</span><span class="hl-3">fileID</span><span class="hl-5">}</span><span class="hl-1">`</span><span class="hl-0">)</span><br/><span class="hl-0">).</span><span class="hl-7">catch</span><span class="hl-0">(</span><span class="hl-3">err</span><span class="hl-0"> </span><span class="hl-5">=&gt;</span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">error</span><span class="hl-0">(</span><span class="hl-1">&#39;oops&#39;</span><span class="hl-0">, </span><span class="hl-3">err</span><span class="hl-0">));</span> </code></pre> <br> </dd><dt>example</dt><dd><p><strong>Upload a <a href="NodeFile.html">NodeFile</a> from a JSON object</strong></p> <pre><code class="language-javascript"><span class="hl-2">import</span><span class="hl-0"> { </span><span class="hl-3">NodeFile</span><span class="hl-0"> } </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-1">&#39;@graphistry/node-api&#39;</span><span class="hl-0">;</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">nodesFile</span><span class="hl-0"> = </span><span class="hl-5">new</span><span class="hl-0"> </span><span class="hl-7">NodeFile</span><span class="hl-0">({</span><span class="hl-1">&#39;n&#39;</span><span class="hl-3">:</span><span class="hl-0"> [</span><span class="hl-1">&#39;a&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;b&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;c&#39;</span><span class="hl-0">]});</span><br/><span class="hl-2">await</span><span class="hl-0"> </span><span class="hl-3">nodesFile</span><span class="hl-0">.</span><span class="hl-7">upload</span><span class="hl-0">(</span><span class="hl-3">client</span><span class="hl-0">);</span><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-1">`NodeFile uploaded as ID </span><span class="hl-5">${</span><span class="hl-3">nodesFile</span><span class="hl-8">.</span><span class="hl-3">fileID</span><span class="hl-5">}</span><span class="hl-1">`</span><span class="hl-0">);</span> </code></pre> <br> </dd><dt>example</dt><dd><p><strong>Upload a <a href="NodeFile.html">NodeFile</a> from an Apache Arrow Table</strong></p> <pre><code class="language-javascript"><span class="hl-2">import</span><span class="hl-0"> { </span><span class="hl-3">tableFromArrays</span><span class="hl-0">, </span><span class="hl-3">tableToIPC</span><span class="hl-0"> } </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-1">&#39;apache-arrow&#39;</span><span class="hl-0">;</span><br/><span class="hl-2">import</span><span class="hl-0"> { </span><span class="hl-3">NodeFile</span><span class="hl-0"> } </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-1">&#39;@graphistry/node-api&#39;</span><span class="hl-0">;</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">json</span><span class="hl-0"> = {</span><span class="hl-1">&#39;n&#39;</span><span class="hl-3">:</span><span class="hl-0"> [</span><span class="hl-1">&#39;a&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;b&#39;</span><span class="hl-0">, </span><span class="hl-1">&#39;c&#39;</span><span class="hl-0">]};</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">arr</span><span class="hl-0"> = </span><span class="hl-7">tableFromArrays</span><span class="hl-0">(</span><span class="hl-3">json</span><span class="hl-0">);</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">uint8Buf</span><span class="hl-0"> = </span><span class="hl-7">tableToIPC</span><span class="hl-0">(</span><span class="hl-3">arr</span><span class="hl-0">);</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">nodesFile</span><span class="hl-0"> = </span><span class="hl-5">new</span><span class="hl-0"> </span><span class="hl-7">NodeFile</span><span class="hl-0">(</span><span class="hl-3">uint8Buf</span><span class="hl-0">, </span><span class="hl-1">&#39;arrow&#39;</span><span class="hl-0">);</span><br/><span class="hl-2">await</span><span class="hl-0"> </span><span class="hl-3">nodesFile</span><span class="hl-0">.</span><span class="hl-7">upload</span><span class="hl-0">(</span><span class="hl-3">client</span><span class="hl-0">);</span><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-1">`NodeFile uploaded as ID </span><span class="hl-5">${</span><span class="hl-3">nodesFile</span><span class="hl-8">.</span><span class="hl-3">fileID</span><span class="hl-5">}</span><span class="hl-1">`</span><span class="hl-0">);</span> </code></pre> <br> </dd><dt>example</dt><dd><p><strong>Create a <a href="File.html">File</a> by ID (e.g., previously uploaded) for use with <a href="Dataset.html">Dataset</a>s</strong></p> <pre><code class="language-javascript"><span class="hl-2">import</span><span class="hl-0"> { </span><span class="hl-3">EdgeFile</span><span class="hl-0">, </span><span class="hl-3">Dataset</span><span class="hl-0"> } </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-1">&#39;@graphistry/node-api&#39;</span><span class="hl-0">;</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">edgesFile</span><span class="hl-0"> = </span><span class="hl-5">new</span><span class="hl-0"> </span><span class="hl-7">EdgeFile</span><span class="hl-0">(</span><span class="hl-1">&#39;my_file_id&#39;</span><span class="hl-0">);</span><br/><span class="hl-2">await</span><span class="hl-0"> (</span><span class="hl-5">new</span><span class="hl-0"> </span><span class="hl-7">Dataset</span><span class="hl-0">(</span><span class="hl-3">bindings</span><span class="hl-0">, </span><span class="hl-3">edgesFile</span><span class="hl-0">)).</span><span class="hl-7">upload</span><span class="hl-0">(</span><span class="hl-3">client</span><span class="hl-0">);</span><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-1">`Dataset uploaded as ID </span><span class="hl-5">${</span><span class="hl-3">dataset</span><span class="hl-8">.</span><span class="hl-3">datasetID</span><span class="hl-5">}</span><span class="hl-1">`</span><span class="hl-0">);</span> </code></pre> </dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">File</span><ul class="tsd-hierarchy"><li><a href="EdgeFile.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeFile</a></li><li><a href="NodeFile.html" class="tsd-signature-type" data-tsd-kind="Class">NodeFile</a></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="File.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="File.html#createFile" class="tsd-kind-icon">create<wbr/>File</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="File.html#setData" class="tsd-kind-icon">set<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="File.html#upload" class="tsd-kind-icon">upload</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="File.html#uploadData" class="tsd-kind-icon">upload<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="File.html#fillMetadata" class="tsd-kind-icon">fill<wbr/>Metadata</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="File.html#createOpts" class="tsd-kind-icon">create<wbr/>Opts</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="File.html#fileFormat" class="tsd-kind-icon">file<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="File.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="File.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="File.html#uploadUrlOpts" class="tsd-kind-icon">upload<wbr/>Url<wbr/>Opts</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="File.html#_data" class="tsd-kind-icon">_data</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="File.html#_fileCreateResponse" class="tsd-kind-icon">_file<wbr/>Create<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="File.html#_fileCreated" class="tsd-kind-icon">_file<wbr/>Created</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="File.html#_fileID" class="tsd-kind-icon">_fileID</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="File.html#_fileUploadResponse" class="tsd-kind-icon">_file<wbr/>Upload<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="File.html#_fileUploaded" class="tsd-kind-icon">_file<wbr/>Uploaded</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="File.html#_fileValidated" class="tsd-kind-icon">_file<wbr/>Validated</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="File.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="File.html#fileCreateResponse" class="tsd-kind-icon">file<wbr/>Create<wbr/>Response</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="File.html#fileCreated" class="tsd-kind-icon">file<wbr/>Created</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="File.html#fileID" class="tsd-kind-icon">fileID</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="File.html#fileUploadResponse" class="tsd-kind-icon">file<wbr/>Upload<wbr/>Response</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="File.html#fileUploaded" class="tsd-kind-icon">file<wbr/>Uploaded</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="File.html#fileValidated" class="tsd-kind-icon">file<wbr/>Validated</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>File<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../enums/FileType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">FileType</a>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, fileFormat<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, createOpts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span>, uploadUrlOpts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="File.html" class="tsd-signature-type" data-tsd-kind="Class">File</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L183">File.ts:183</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>See examples at top of file</p> </div><div><p>Create a new <a href="File.html">File</a> object for uploading or use with <a href="Dataset.html">Dataset</a></p> <p>For more information on the available options, see:</p> <ul> <li>Creation step metadata options: <a href="https://hub.graphistry.com/docs/api/2/rest/files/">https://hub.graphistry.com/docs/api/2/rest/files/</a></li> <li>Upload step options: <a href="https://hub.graphistry.com/docs/api/2/rest/files/#uploadfiledata">https://hub.graphistry.com/docs/api/2/rest/files/#uploadfiledata</a></li> </ul> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <a href="../enums/FileType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">FileType</a></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>FileType.Node or FileType.Edge</p> </div></div></li><li><h5>data: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Payload to pass to node-fetch. Use TypedArrays such as Uint8Array for binary data such as arrow</p> </div></div></li><li><h5>fileFormat: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;json&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>File format to use, e.g. &#39;json&#39;, &#39;csv&#39;, &#39;arrow&#39;, &#39;parquet&#39;, &#39;orc&#39;, &#39;xls&#39;</p> </div></div></li><li><h5>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;my file&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Name of the file to use, e.g. &#39;my-file&#39;</p> </div></div></li><li><h5>createOpts: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>JSON post body options to use in createFile()</p> </div></div><ul class="tsd-parameters"></ul></li><li><h5>uploadUrlOpts: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>URL options to use in uploadData()</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="File.html" class="tsd-signature-type" data-tsd-kind="Class">File</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFile" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>File<a href="#createFile" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>File<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a>, force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L245">File.ts:245</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>See examples at top of file</p> </div><div><p>Helper function to create the file on the server but not yet upload its data</p> <p>By default, this will skip recreating files that have already been created.</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p><a href="Client.html">Client</a> object to use for uploading</p> </div></div></li><li><h5>force: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>If true, will force creation of a new ID even if file has already been uploaded</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Data<a href="#setData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Data<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L306">File.ts:306</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>See examples at top of file</p> </div><div><p>Populate data for later uploading if it wasn&#39;t set during construction</p> <p>Cannot run this function if the file has already been uploaded</p> <p>Overwrites any existing data</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>Data to use for uploading</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="upload" class="tsd-anchor"></a><h3 class="tsd-anchor-link">upload<a href="#upload" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">upload<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a>, force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="File.html" class="tsd-signature-type" data-tsd-kind="Class">File</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L212">File.ts:212</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>See examples at top of file</p> </div><div><p>Upload curent <a href="File.html">File</a> object to the server</p> <p>By default, this will skip reuploading files that have already been uploaded.</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p><a href="Client.html">Client</a> object to use for uploading</p> </div></div></li><li><h5>force: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>If true, will force upload even if file has already been uploaded</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="File.html" class="tsd-signature-type" data-tsd-kind="Class">File</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>Promise that resolves to the uploaded File object when it completes uploading</p> </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="uploadData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">upload<wbr/>Data<a href="#uploadData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">upload<wbr/>Data<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a>, force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L278">File.ts:278</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>See examples at top of file</p> </div><div><p>Helper function to upload the data to the server</p> <p>By default, this will skip reuploading data that has already been uploaded.</p> </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p><a href="Client.html">Client</a> object to use for uploading</p> </div></div></li><li><h5>force: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead"> <p>If true, will force upload even if file has already been uploaded</p> </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fillMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> fill<wbr/>Metadata<a href="#fillMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">fill<wbr/>Metadata<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, client<span class="tsd-signature-symbol">: </span><a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L315">File.ts:315</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span></h5></li><li><h5>client: <a href="../modules.html#ClientType" class="tsd-signature-type" data-tsd-kind="Type alias">ClientType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="createOpts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> create<wbr/>Opts<a href="#createOpts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">create<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L158">File.ts:158</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="fileFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> file<wbr/>Format<a href="#fileFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">file<wbr/>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L160">File.ts:160</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> name<a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L161">File.ts:161</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/FileType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">FileType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L162">File.ts:162</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="uploadUrlOpts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> upload<wbr/>Url<wbr/>Opts<a href="#uploadUrlOpts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">upload<wbr/>Url<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L159">File.ts:159</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> _data<a href="#_data" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">_data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L133">File.ts:133</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_fileCreateResponse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> _file<wbr/>Create<wbr/>Response<a href="#_fileCreateResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">_file<wbr/>Create<wbr/>Response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L144">File.ts:144</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_fileCreated" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> _file<wbr/>Created<a href="#_fileCreated" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">_file<wbr/>Created<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L141">File.ts:141</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_fileID" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagOptional">Optional</span> _fileID<a href="#_fileID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">_fileID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/graphistry/graphistry-js/blob/master/projects/node-api/src/File.ts#L138">File.ts:138</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_fileUploadResponse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> _file<wbr/>Upload<wbr/>Response<a href="#_fileUploadResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">_file<wbr/>Upload<wbr/>Response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><