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

# visualizeImageChart

<div className="kinetica-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="visualizeImageChart(com.gpudb.protocol.VisualizeImageChartRequest)">
        <h3>visualizeImageChart</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartResponse" title="class in com.gpudb.protocol">VisualizeImageChartResponse</a></span> <span className="element-name">visualizeImageChart</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest" title="class in com.gpudb.protocol">VisualizeImageChartRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">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 <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartResponse#getImageData()"><code>imageData</code></a> field.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="visualizeImageChart(java.lang.String,java.util.List,java.util.List,double,double,double,double,int,int,java.lang.String,java.util.Map,java.util.Map)">
        <h3>visualizeImageChart</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartResponse" title="class in com.gpudb.protocol">VisualizeImageChartResponse</a></span> <span className="element-name">visualizeImageChart</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> xColumnNames, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> yColumnNames, double minX, double maxX, double minY, double maxY, int width, int height, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> bgColor, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>>> styleOptions, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">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 <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartResponse#getImageData()"><code>imageData</code></a> field.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>tableName</code> - Name of the table containing the data to be drawn as a chart, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>.</div>
          <div className="dd"><code>xColumnNames</code> - Names of the columns containing the data mapped to the x axis of a chart.</div>
          <div className="dd"><code>yColumnNames</code> - Names of the columns containing the data mapped to the y axis of a chart.</div>
          <div className="dd"><code>minX</code> - 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.</div>
          <div className="dd"><code>maxX</code> - 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.</div>
          <div className="dd"><code>minY</code> - 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.</div>
          <div className="dd"><code>maxY</code> - 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.</div>
          <div className="dd"><code>width</code> - Width of the generated image in pixels.</div>
          <div className="dd"><code>height</code> - Height of the generated image in pixels.</div>
          <div className="dd"><code>bgColor</code> - Background color of the generated image.</div>

          <div className="dd">
            <code>styleOptions</code> - Rendering style options for a chart.

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#POINTCOLOR"><code>POINTCOLOR</code></a>: The color of points in the plot represented as a hexadecimal number. The default value is '0000FF'. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#POINTSIZE"><code>POINTSIZE</code></a>: The size of points in the plot represented as number of pixels. The default value is '3'. </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#POINTSHAPE"><code>POINTSHAPE</code></a>: The shape of points in the plot. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#NONE"><code>NONE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#CIRCLE"><code>CIRCLE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#SQUARE"><code>SQUARE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#DIAMOND"><code>DIAMOND</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#HOLLOWCIRCLE"><code>HOLLOWCIRCLE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#HOLLOWSQUARE"><code>HOLLOWSQUARE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#HOLLOWDIAMOND"><code>HOLLOWDIAMOND</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#SQUARE"><code>SQUARE</code></a>.
              </li>

              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#CB_POINTCOLORS"><code>CB\_POINTCOLORS</code></a>: Point color class break information consisting of three entries: class-break attribute, class-break values/ranges, and point color values. This option overrides the pointcolor option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point color values are separated by cb\_delimiter, e.g. {"{"}"price", "20:30;30:40;40:50", "0xFF0000;0x00FF00;0x0000FF"{"}"}. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#CB_POINTSIZES"><code>CB\_POINTSIZES</code></a>: Point size class break information consisting of three entries: class-break attribute, class-break values/ranges, and point size values. This option overrides the pointsize option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point size values are separated by cb\_delimiter, e.g. {"{"}"states", "NY;TX;CA", "3;5;7"{"}"}. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#CB_POINTSHAPES"><code>CB\_POINTSHAPES</code></a>: Point shape class break information consisting of three entries: class-break attribute, class-break values/ranges, and point shape names. This option overrides the pointshape option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point shape names are separated by cb\_delimiter, e.g. {"{"}"states", "NY;TX;CA", "circle;square;diamond"{"}"}. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#CB_DELIMITER"><code>CB\_DELIMITER</code></a>: A character or string which separates per-class values in a class-break style option string. The default value is ';'. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#X_ORDER_BY"><code>X\_ORDER\_BY</code></a>: An expression or aggregate expression by which non-numeric x column values are sorted, e.g. "avg(price) descending". </li>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#Y_ORDER_BY"><code>Y\_ORDER\_BY</code></a>: An expression or aggregate expression by which non-numeric y column values are sorted, e.g. "avg(price)", which defaults to "avg(price) ascending". </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#SCALE_TYPE_X"><code>SCALE\_TYPE\_X</code></a>: Type of x axis scale. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#NONE"><code>NONE</code></a>: No scale is applied to the x axis. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#LOG"><code>LOG</code></a>: A base-10 log scale is applied to the x axis. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#NONE"><code>NONE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#SCALE_TYPE_Y"><code>SCALE\_TYPE\_Y</code></a>: Type of y axis scale. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#NONE"><code>NONE</code></a>: No scale is applied to the y axis. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#LOG"><code>LOG</code></a>: A base-10 log scale is applied to the y axis. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#NONE"><code>NONE</code></a>.
              </li>

              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#MIN_MAX_SCALED"><code>MIN\_MAX\_SCALED</code></a>: If this options is set to <code>FALSE</code>, this endpoint expects request's min/max values are not yet scaled. They will be scaled according to scale\_type\_x or scale\_type\_y for response. If this options is set to <code>TRUE</code>, this endpoint expects request's min/max values are already scaled according to scale\_type\_x/scale\_type\_y. Response's min/max values will be equal to request's min/max values. The default value is 'false'. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#JITTER_X"><code>JITTER\_X</code></a>: Amplitude of horizontal jitter applied to non-numeric x column values. The default value is '0.0'. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#JITTER_Y"><code>JITTER\_Y</code></a>: Amplitude of vertical jitter applied to non-numeric y column values. The default value is '0.0'. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.StyleOptions#PLOT_ALL"><code>PLOT\_ALL</code></a>: If this options is set to <code> TRUE</code>, all non-numeric column values are plotted ignoring min\_x, max\_x, min\_y and max\_y parameters. The default value is 'false'. </li>
            </ul>
          </div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li>
                <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.Options#IMAGE_ENCODING"><code>IMAGE\_ENCODING</code></a>: Encoding to be applied to the output image. When using JSON serialization it is recommended to specify this as <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.Options#BASE64"><code>BASE64</code></a>. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.Options#BASE64"><code>BASE64</code></a>: Apply base64 encoding to the output image. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.Options#NONE"><code>NONE</code></a>: Do not apply any additional encoding to the output image. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartRequest.Options#NONE"><code>NONE</code></a>.
              </li>
            </ul>

            The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/VisualizeImageChartResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>
