> ## 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.

# visualize_isochrone

### visualize\_isochrone

<ul>
  <li>
    visualize\_isochrone(\
    &#x20;graph\_name: string,\
    &#x20;source\_node: string,\
    &#x20;max\_solution\_radius: number | undefined,\
    &#x20;weights\_on\_edges: string\[] | undefined,\
    &#x20;restrictions: string\[] | undefined,\
    &#x20;num\_levels: number | undefined,\
    &#x20;generate\_image: boolean | undefined,\
    &#x20;levels\_table: string | undefined,\
    &#x20;style\_options: Record\<string, string>,\
    &#x20;solve\_options?: Record\<string, string>,\
    &#x20;contour\_options?: Record\<string, string>,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[VisualizeIsochroneResponse](https://docs.kinetica.com/content/api/typescript/interfaces/VisualizeIsochroneResponse.md)>

    Generate an image containing isolines for travel results using an existing graph. Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs and Solvers for more information on graphs.

    #### Parameters

    <ul>
      <li>
        graph\_name: string

        Name of the graph on which the isochrone is to be computed.
      </li>

      <li>
        source\_node: string

        Starting vertex on the underlying graph from/to which the isochrones are created.
      </li>

      <li>
        max\_solution\_radius: number | undefined

        Extent of the search radius around `source_node`. Set to '-1.0' for unrestricted search radius.
      </li>

      <li>
        weights\_on\_edges: string\[] | undefined

        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).
      </li>

      <li>
        restrictions: string\[] | undefined

        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').
      </li>

      <li>
        num\_levels: number | undefined

        Number of equally-separated isochrones to compute.
      </li>

      <li>
        generate\_image: boolean | undefined

        If set to true, generates a PNG image of the isochrones in the response.
      </li>

      <li>
        levels\_table: string | undefined

        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.
      </li>

      <li>
        style\_options: Record\<string, string>

        Various style related options of the isochrone image.
      </li>

      <li>
        `Optional`solve\_options: Record\<string, string>

        Solver specific parameters.
      </li>

      <li>
        `Optional`contour\_options: Record\<string, string>

        Contour specific parameters.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Additional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[VisualizeIsochroneResponse](https://docs.kinetica.com/content/api/typescript/interfaces/VisualizeIsochroneResponse.md)>

    Promise\<Types.VisualizeIsochroneResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:16077](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L16077)</li>
    </ul>
  </li>
</ul>

### visualize\_isochrone\_request

<ul>
  <li>
    visualize\_isochrone\_request(\
    &#x20;request: [VisualizeIsochroneRequest](https://docs.kinetica.com/content/api/typescript/interfaces/VisualizeIsochroneRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[VisualizeIsochroneResponse](https://docs.kinetica.com/content/api/typescript/interfaces/VisualizeIsochroneResponse.md)>

    Generate an image containing isolines for travel results using an existing graph. Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs and Solvers for more information on graphs.

    #### Parameters

    <ul>
      <li>
        request: [VisualizeIsochroneRequest](https://docs.kinetica.com/content/api/typescript/interfaces/VisualizeIsochroneRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[VisualizeIsochroneResponse](https://docs.kinetica.com/content/api/typescript/interfaces/VisualizeIsochroneResponse.md)>

    Promise\<Types.VisualizeIsochroneResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:16030](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L16030)</li>
    </ul>
  </li>
</ul>


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