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

### visualize\_image\_heatmap

<ul>
  <li>
    visualize\_image\_heatmap(\
    &#x20;table\_names: string\[],\
    &#x20;x\_column\_name: string,\
    &#x20;y\_column\_name: string,\
    &#x20;value\_column\_name: string,\
    &#x20;geometry\_column\_name: string,\
    &#x20;min\_x: number,\
    &#x20;max\_x: number,\
    &#x20;min\_y: number,\
    &#x20;max\_y: number,\
    &#x20;width: number,\
    &#x20;height: number,\
    &#x20;projection: string | undefined,\
    &#x20;style\_options: Record\<string, string>,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[VisualizeImageHeatmapResponse](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageHeatmapResponse.md)>

    For internal use only. Generates rasterized heatmap image tiles for an area of interest using the given tables and the provided parameters.All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value).The heatmap image is contained in the `image_data` field.

    #### Parameters

    <ul>
      <li>
        table\_names: string\[]

        Name of the table containing the data for the various layers to be rendered.
      </li>

      <li>
        x\_column\_name: string

        Name of the column containing the x coordinates.
      </li>

      <li>
        y\_column\_name: string

        Name of the column containing the y coordinates.
      </li>

      <li>value\_column\_name: string</li>

      <li>
        geometry\_column\_name: string

        Name of the column containing geometry data.
      </li>

      <li>
        min\_x: number

        Lower bound for the x values.
      </li>

      <li>
        max\_x: number

        Upper bound for the x values.
      </li>

      <li>
        min\_y: number

        Lower bound for the y values.
      </li>

      <li>
        max\_y: number

        Upper bound for the y values.
      </li>

      <li>
        width: number

        Width of the generated image.
      </li>

      <li>
        height: number

        Height of the generated image.
      </li>

      <li>
        projection: string | undefined

        Spatial Reference System (i.e. EPSG Code).
      </li>

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

        Various style related options.
      </li>

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

        Optional parameters.
      </li>

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

        Optional callback function
      </li>
    </ul>

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

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

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

### visualize\_image\_heatmap\_request

<ul>
  <li>
    visualize\_image\_heatmap\_request(\
    &#x20;request: [VisualizeImageHeatmapRequest](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageHeatmapRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[VisualizeImageHeatmapResponse](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageHeatmapResponse.md)>

    For internal use only. Generates rasterized heatmap image tiles for an area of interest using the given tables and the provided parameters.All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value).The heatmap image is contained in the `image_data` field.

    #### Parameters

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

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

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

        Optional callback function
      </li>
    </ul>

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

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

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


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