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

# VisualizeImageRequest

> VisualizeImageRequest — Kinetica Node.js API

interface VisualizeImageRequest \{\
&#x20;[bg\_color](#bg_color): number;\
&#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:5354](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5354)</li>
</ul>

##### Index

### Properties

[bg\_color](#bg_color) [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:5384](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5384)</li>
</ul>

### geometry\_column\_name

geometry\_column\_name: string

Name of the column containing geometry data.

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

### height

height: number

Height of the generated image.

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

### max\_x

max\_x: number

Upper bound for the x values.

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

### max\_y

max\_y: number

Upper bound for the y values.

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

### min\_x

min\_x: number

Lower bound for the x values.

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

### min\_y

min\_y: number

Lower bound for the y values.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### `Optional`projection

projection?: string

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

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

### style\_options

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

Styling options for the image.

<ul>
  <li>Defined in [src/types.ts:5386](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5386)</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:5364](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5364)</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:5356](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5356)</li>
</ul>

### track\_ids

track\_ids: string\[]\[]

Tracks from the `table_names` to be rendered.

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

### width

width: number

Width of the generated image.

<ul>
  <li>Defined in [src/types.ts:5378](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5378)</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:5358](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L5358)</li>
</ul>

### x\_column\_name

x\_column\_name: string

Name of the column containing the x coordinates.

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

### y\_column\_name

y\_column\_name: string

Name of the column containing the y coordinates.

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


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