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

### visualize\_image\_classbreak

<ul>
  <li>
    visualize\_image\_classbreak(\
    &#x20;table\_names: string\[],\
    &#x20;world\_table\_names: string\[],\
    &#x20;x\_column\_name: string,\
    &#x20;y\_column\_name: string,\
    &#x20;symbol\_column\_name: string,\
    &#x20;geometry\_column\_name: string,\
    &#x20;track\_ids: string\[]\[],\
    &#x20;cb\_attr: string,\
    &#x20;cb\_vals: string\[],\
    &#x20;cb\_pointcolor\_attr: string,\
    &#x20;cb\_pointcolor\_vals: string\[],\
    &#x20;cb\_pointalpha\_attr: string,\
    &#x20;cb\_pointalpha\_vals: string\[],\
    &#x20;cb\_pointsize\_attr: string,\
    &#x20;cb\_pointsize\_vals: string\[],\
    &#x20;cb\_pointshape\_attr: string,\
    &#x20;cb\_pointshape\_vals: 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;bg\_color: number,\
    &#x20;style\_options: Record\<string, string\[]>,\
    &#x20;options: Record\<string, string> | undefined,\
    &#x20;cb\_transparency\_vec: number\[],\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[VisualizeImageClassbreakResponse](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageClassbreakResponse.md)>

    For internal use only. Generates 'class break' rasterized image tiles for an area of interest using the given tables and the provided parameters.A class break rendering is where data from one or more tables is rasterized with styling applied on a per-class basis. Class breaks based on one or more data columns are supported. Distinct values (for strings) or ranges (for numeric attributes) must be provided in the cb\_column\_name1/cb\_vals1 and cb\_column\_name2/cb\_vals2 parameters. The styling parameters must be specified for each class.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\_names: string\[]

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

      <li>
        world\_table\_names: string\[]

        Optional name of the tables containing the data for the entire track when the `table_names` contains only part of the track data, but the entire track has 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>
        symbol\_column\_name: string

        Name of the column containing the symbol code coordinates.
      </li>

      <li>
        geometry\_column\_name: string

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

      <li>
        track\_ids: string\[]\[]

        Tracks from the `table_names` to be rendered.
      </li>

      <li>
        cb\_attr: string

        Name of the column for the generic class break.
      </li>

      <li>
        cb\_vals: string\[]

        A list of class break values or ranges (e.g. '0:5,5:10,15:30').
      </li>

      <li>
        cb\_pointcolor\_attr: string

        Name of the column for the point color class break.
      </li>

      <li>
        cb\_pointcolor\_vals: string\[]

        A list of class break values or ranges (e.g. '0:5,5:10,15:30').
      </li>

      <li>
        cb\_pointalpha\_attr: string

        Name of the column for the point alpha class break.
      </li>

      <li>
        cb\_pointalpha\_vals: string\[]

        A list of class break values or ranges (e.g. '0:5,5:10,15:30').
      </li>

      <li>
        cb\_pointsize\_attr: string

        Name of the column for the point size class break.
      </li>

      <li>
        cb\_pointsize\_vals: string\[]

        A list of class break values or ranges (e.g. '0:5,5:10,15:30').
      </li>

      <li>
        cb\_pointshape\_attr: string

        Name of the column for the point shape class break.
      </li>

      <li>
        cb\_pointshape\_vals: string\[]

        A list of class break values or ranges (e.g. '0:5,5:10,15:30').
      </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>
        bg\_color: number

        Background color of the generated image.
      </li>

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

        Styling options for the image.
      </li>

      <li>
        options: Record\<string, string> | undefined

        Optional parameters.
      </li>

      <li>
        cb\_transparency\_vec: number\[]

        Used for internal purpose. Indicating the color of each class is semi-transparent or not (0: opaque or completely transparent, 1: semi-transparent).
      </li>

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

        Optional callback function
      </li>
    </ul>

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

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

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

### visualize\_image\_classbreak\_request

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

    For internal use only. Generates 'class break' rasterized image tiles for an area of interest using the given tables and the provided parameters.A class break rendering is where data from one or more tables is rasterized with styling applied on a per-class basis. Class breaks based on one or more data columns are supported. Distinct values (for strings) or ranges (for numeric attributes) must be provided in the cb\_column\_name1/cb\_vals1 and cb\_column\_name2/cb\_vals2 parameters. The styling parameters must be specified for each class.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: [VisualizeImageClassbreakRequest](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageClassbreakRequest.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\<[VisualizeImageClassbreakResponse](https://docs.kinetica.com/content/api/javascript/interfaces/VisualizeImageClassbreakResponse.md)>

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

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


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