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

### visualize\_image\_chart

<ul>
  <li>
    visualize\_image\_chart(\
    &#x20;table\_name: string,\
    &#x20;x\_column\_names: string\[],\
    &#x20;y\_column\_names: string\[],\
    &#x20;min\_x: number,\
    &#x20;max\_x: number,\
    &#x20;min\_y: number,\
    &#x20;max\_y: number,\
    &#x20;width: number,\
    &#x20;height: number,\
    &#x20;bg\_color: string,\
    &#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\<[VisualizeImageChartResponse](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageChartResponse.md)>

    Scatter plot is the only plot type currently supported. A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value).The image is contained in the `image_data` field.

    #### Parameters

    <ul>
      <li>
        table\_name: string

        Name of the table containing the data to be drawn as a chart, in \[schema\_name.]table\_name format, using standard name resolution rules.
      </li>

      <li>
        x\_column\_names: string\[]

        Names of the columns containing the data mapped to the x axis of a chart.
      </li>

      <li>
        y\_column\_names: string\[]

        Names of the columns containing the data mapped to the y axis of a chart.
      </li>

      <li>
        min\_x: number

        Lower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
      </li>

      <li>
        max\_x: number

        Upper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
      </li>

      <li>
        min\_y: number

        Lower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
      </li>

      <li>
        max\_y: number

        Upper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
      </li>

      <li>
        width: number

        Width of the generated image in pixels.
      </li>

      <li>
        height: number

        Height of the generated image in pixels.
      </li>

      <li>
        bg\_color: string

        Background color of the generated image.
      </li>

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

        Rendering style options for a chart.
      </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\<[VisualizeImageChartResponse](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageChartResponse.md)>

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

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

### visualize\_image\_chart\_request

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

    Scatter plot is the only plot type currently supported. A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value).The image is contained in the `image_data` field.

    #### Parameters

    <ul>
      <li>
        request: [VisualizeImageChartRequest](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageChartRequest.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\<[VisualizeImageChartResponse](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageChartResponse.md)>

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

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


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