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

# VisualizeImageClassbreakRequest

> VisualizeImageClassbreakRequest — Kinetica TypeScript API

interface VisualizeImageClassbreakRequest \{\
&#x20;[bg\_color](#bg_color): number;\
&#x20;[cb\_attr](#cb_attr): string;\
&#x20;[cb\_pointalpha\_attr](#cb_pointalpha_attr): string;\
&#x20;[cb\_pointalpha\_vals](#cb_pointalpha_vals): string\[];\
&#x20;[cb\_pointcolor\_attr](#cb_pointcolor_attr): string;\
&#x20;[cb\_pointcolor\_vals](#cb_pointcolor_vals): string\[];\
&#x20;[cb\_pointshape\_attr](#cb_pointshape_attr): string;\
&#x20;[cb\_pointshape\_vals](#cb_pointshape_vals): string\[];\
&#x20;[cb\_pointsize\_attr](#cb_pointsize_attr): string;\
&#x20;[cb\_pointsize\_vals](#cb_pointsize_vals): string\[];\
&#x20;[cb\_transparency\_vec](#cb_transparency_vec): number\[];\
&#x20;[cb\_vals](#cb_vals): string\[];\
&#x20;[geometry\_column\_name](#geometry_column_name): string;\
&#x20;[height](#height): number;\
&#x20;[max\_x](#max_x): number;\
&#x20;[max\_y](#max_y): number;\
&#x20;[min\_x](#min_x): number;\
&#x20;[min\_y](#min_y): number;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[projection](#projection)?: string;\
&#x20;[style\_options](#style_options): Record\<string, string\[]>;\
&#x20;[symbol\_column\_name](#symbol_column_name): string;\
&#x20;[table\_names](#table_names): string\[];\
&#x20;[track\_ids](#track_ids): string\[]\[];\
&#x20;[width](#width): number;\
&#x20;[world\_table\_names](#world_table_names): string\[];\
&#x20;[x\_column\_name](#x_column_name): string;\
&#x20;[y\_column\_name](#y_column_name): string;\
}

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

##### Index

### Properties

[bg\_color](#bg_color) [cb\_attr](#cb_attr) [cb\_pointalpha\_attr](#cb_pointalpha_attr) [cb\_pointalpha\_vals](#cb_pointalpha_vals) [cb\_pointcolor\_attr](#cb_pointcolor_attr) [cb\_pointcolor\_vals](#cb_pointcolor_vals) [cb\_pointshape\_attr](#cb_pointshape_attr) [cb\_pointshape\_vals](#cb_pointshape_vals) [cb\_pointsize\_attr](#cb_pointsize_attr) [cb\_pointsize\_vals](#cb_pointsize_vals) [cb\_transparency\_vec](#cb_transparency_vec) [cb\_vals](#cb_vals) [geometry\_column\_name](#geometry_column_name) [height](#height) [max\_x](#max_x) [max\_y](#max_y) [min\_x](#min_x) [min\_y](#min_y) [options?](#options) [projection?](#projection) [style\_options](#style_options) [symbol\_column\_name](#symbol_column_name) [table\_names](#table_names) [track\_ids](#track_ids) [width](#width) [world\_table\_names](#world_table_names) [x\_column\_name](#x_column_name) [y\_column\_name](#y_column_name)&#x20;

## Properties

### bg\_color

bg\_color: number

Background color of the generated image.

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

### cb\_attr

cb\_attr: string

Name of the column for the generic class break.

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

### cb\_pointalpha\_attr

cb\_pointalpha\_attr: string

Name of the column for the point alpha class break.

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

### cb\_pointalpha\_vals

cb\_pointalpha\_vals: string\[]

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

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

### cb\_pointcolor\_attr

cb\_pointcolor\_attr: string

Name of the column for the point color class break.

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

### cb\_pointcolor\_vals

cb\_pointcolor\_vals: string\[]

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

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

### cb\_pointshape\_attr

cb\_pointshape\_attr: string

Name of the column for the point shape class break.

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

### cb\_pointshape\_vals

cb\_pointshape\_vals: string\[]

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

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

### cb\_pointsize\_attr

cb\_pointsize\_attr: string

Name of the column for the point size class break.

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

### cb\_pointsize\_vals

cb\_pointsize\_vals: string\[]

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

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

### cb\_transparency\_vec

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

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

### cb\_vals

cb\_vals: string\[]

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

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

### geometry\_column\_name

geometry\_column\_name: string

Name of the column containing geometry data.

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

### height

height: number

Height of the generated image.

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

### max\_x

max\_x: number

Upper bound for the x values.

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

### max\_y

max\_y: number

Upper bound for the y values.

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

### min\_x

min\_x: number

Lower bound for the x values.

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

### min\_y

min\_y: number

Lower bound for the y values.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### `Optional`projection

projection?: string

Spatial Reference System (i.e. EPSG Code).

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

### style\_options

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

Styling options for the image.

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

### symbol\_column\_name

symbol\_column\_name: string

Name of the column containing the symbol code coordinates.

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

### table\_names

table\_names: string\[]

Name of the table containing the data for the various layers to be rendered.

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

### track\_ids

track\_ids: string\[]\[]

Tracks from the `table_names` to be rendered.

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

### width

width: number

Width of the generated image.

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

### world\_table\_names

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.

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

### x\_column\_name

x\_column\_name: string

Name of the column containing the x coordinates.

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

### y\_column\_name

y\_column\_name: string

Name of the column containing the y coordinates.

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


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