> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# VisualizeIsochroneRequest

> VisualizeIsochroneRequest — Kinetica JavaScript API

<div className="kinetica-typedoc">
  <div className="tsd-page-title" />

  <div className="tsd-signature"><span className="tsd-signature-keyword">interface</span> <span className="tsd-kind-interface">VisualizeIsochroneRequest</span> <span className="tsd-signature-symbol">{"{"}</span><br /> <a className="tsd-kind-property" href="#contour_options">contour\_options</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#generate_image">generate\_image</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">boolean</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#graph_name">graph\_name</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#levels_table">levels\_table</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#max_solution_radius">max\_solution\_radius</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#num_levels">num\_levels</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#options">options</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#restrictions">restrictions</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#solve_options">solve\_options</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#source_node">source\_node</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#style_options">style\_options</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#weights_on_edges">weights\_on\_edges</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">;</span><br /><span className="tsd-signature-symbol">{"}"}</span></div>

  <div className="aside tsd-sources">
    <ul>
      <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5702">src/types.ts:5702</a></li>
    </ul>
  </div>

  <div className="section tsd-panel-group tsd-index-group">
    <div className="section tsd-panel tsd-index-panel">
      <div className="details tsd-index-content tsd-accordion" open="">
        <div className="summary tsd-accordion-summary tsd-index-summary">
          <h5 className="tsd-index-heading uppercase">Index</h5>
        </div>

        <div className="tsd-accordion-details">
          <div className="section tsd-index-section">
            <h3 className="tsd-index-heading tsd-anchor-link" id="properties">Properties</h3>
            <div className="tsd-index-list"><a href="#contour_options" className="tsd-index-link"><span>contour\_options?</span></a> <a href="#generate_image" className="tsd-index-link"><span>generate\_image?</span></a> <a href="#graph_name" className="tsd-index-link"><span>graph\_name</span></a> <a href="#levels_table" className="tsd-index-link"><span>levels\_table?</span></a> <a href="#max_solution_radius" className="tsd-index-link"><span>max\_solution\_radius?</span></a> <a href="#num_levels" className="tsd-index-link"><span>num\_levels?</span></a> <a href="#options" className="tsd-index-link"><span>options?</span></a> <a href="#restrictions" className="tsd-index-link"><span>restrictions?</span></a> <a href="#solve_options" className="tsd-index-link"><span>solve\_options?</span></a> <a href="#source_node" className="tsd-index-link"><span>source\_node</span></a> <a href="#style_options" className="tsd-index-link"><span>style\_options</span></a> <a href="#weights_on_edges" className="tsd-index-link"><span>weights\_on\_edges?</span></a> </div>
          </div>
        </div>
      </div>
    </div>
  </div>

  <div className="details tsd-panel-group tsd-member-group tsd-accordion" open="">
    <div className="summary tsd-accordion-summary" data-key="section-Properties">
      <h2 className="tsd-anchor-link" id="properties-1">Properties</h2>
    </div>

    <div className="section">
      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="contour_options"><code className="tsd-tag">Optional</code><span>contour\_options</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">contour\_options</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-comment tsd-typography">
          <p>Contour specific parameters.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5724">src/types.ts:5724</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="generate_image"><code className="tsd-tag">Optional</code><span>generate\_image</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">generate\_image</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">boolean</span></div>

        <div className="tsd-comment tsd-typography">
          <p>If set to true, generates a PNG image of the isochrones in the response.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5716">src/types.ts:5716</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="graph_name"><span>graph\_name</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">graph\_name</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Name of the graph on which the isochrone is to be computed.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5704">src/types.ts:5704</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="levels_table"><code className="tsd-tag">Optional</code><span>levels\_table</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">levels\_table</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">string</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Name of the table to output the isochrones to, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. The table will contain levels and their corresponding WKT geometry. If no value is provided, the table is not generated.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5718">src/types.ts:5718</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="max_solution_radius"><code className="tsd-tag">Optional</code><span>max\_solution\_radius</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">max\_solution\_radius</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Extent of the search radius around <code>source\_node</code>. Set to '-1.0' for unrestricted search radius.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5708">src/types.ts:5708</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="num_levels"><code className="tsd-tag">Optional</code><span>num\_levels</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">num\_levels</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Number of equally-separated isochrones to compute.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5714">src/types.ts:5714</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="options"><code className="tsd-tag">Optional</code><span>options</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">options</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-comment tsd-typography">
          <p>Additional parameters.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5726">src/types.ts:5726</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="restrictions"><code className="tsd-tag">Optional</code><span>restrictions</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">restrictions</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">\[]</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS\_EDGE\_ID', or expressions, e.g., 'column/2 AS RESTRICTIONS\_VALUECOMPARED'. If remove\_previous\_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove\_previous\_restrictions is set to false, any provided restrictions will be added (in the case of 'RESTRICTIONS\_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS\_ONOFFCOMPARED').</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5712">src/types.ts:5712</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="solve_options"><code className="tsd-tag">Optional</code><span>solve\_options</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">solve\_options</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-comment tsd-typography">
          <p>Solver specific parameters.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5722">src/types.ts:5722</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="source_node"><span>source\_node</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">source\_node</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Starting vertex on the underlying graph from/to which the isochrones are created.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5706">src/types.ts:5706</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="style_options"><span>style\_options</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">style\_options</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-comment tsd-typography">
          <p>Various style related options of the isochrone image.</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5720">src/types.ts:5720</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="weights_on_edges"><code className="tsd-tag">Optional</code><span>weights\_on\_edges</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">weights\_on\_edges</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">\[]</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Additional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS\_EDGE\_ID', or expressions, e.g., 'ST\_LENGTH(wkt) AS WEIGHTS\_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS\_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS\_FACTORSPECIFIED') the existing weight(s).</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5710">src/types.ts:5710</a></li>
          </ul>
        </div>
      </div>
    </div>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.