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

# VisualizeImageLabelsRequest

> VisualizeImageLabelsRequest — Kinetica JavaScript API

interface VisualizeImageLabelsRequest \{\
&#x20;[draw\_box](#draw_box)?: string;\
&#x20;[draw\_leader](#draw_leader)?: string;\
&#x20;[fill\_color](#fill_color)?: string;\
&#x20;[filter](#filter)?: string;\
&#x20;[font](#font)?: string;\
&#x20;[height](#height): number;\
&#x20;[leader\_x\_column\_name](#leader_x_column_name)?: string;\
&#x20;[leader\_y\_column\_name](#leader_y_column_name)?: string;\
&#x20;[line\_color](#line_color)?: string;\
&#x20;[line\_width](#line_width)?: string;\
&#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;[table\_name](#table_name): string;\
&#x20;[text\_angle](#text_angle)?: string;\
&#x20;[text\_color](#text_color)?: string;\
&#x20;[text\_scale](#text_scale)?: string;\
&#x20;[text\_string](#text_string): string;\
&#x20;[width](#width): number;\
&#x20;[x\_column\_name](#x_column_name): string;\
&#x20;[x\_offset](#x_offset)?: string;\
&#x20;[y\_column\_name](#y_column_name): string;\
&#x20;[y\_offset](#y_offset)?: string;\
}

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

##### Index

### Properties

[draw\_box?](#draw_box) [draw\_leader?](#draw_leader) [fill\_color?](#fill_color) [filter?](#filter) [font?](#font) [height](#height) [leader\_x\_column\_name?](#leader_x_column_name) [leader\_y\_column\_name?](#leader_y_column_name) [line\_color?](#line_color) [line\_width?](#line_width) [max\_x](#max_x) [max\_y](#max_y) [min\_x](#min_x) [min\_y](#min_y) [options?](#options) [projection?](#projection) [table\_name](#table_name) [text\_angle?](#text_angle) [text\_color?](#text_color) [text\_scale?](#text_scale) [text\_string](#text_string) [width](#width) [x\_column\_name](#x_column_name) [x\_offset?](#x_offset) [y\_column\_name](#y_column_name) [y\_offset?](#y_offset)&#x20;

## Properties

### `Optional`draw\_box

draw\_box?: string

Boolean expression indicating whether boxes will be drawn around the labels. If blank, no boxes will be drawn.

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

### `Optional`draw\_leader

draw\_leader?: string

Boolean expression indicating whether leader lines will be drawn from the labels to points specified using `leader_x_column_name` and `leader_y_column_name`. If blank, no leader lines will be drawn.

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

### `Optional`fill\_color

fill\_color?: string

Numeric expression that evaluates to the fill color for the labels' boxes. If blank, the boxes will not be filled.

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

### `Optional`filter

filter?: string

Boolean expression indicating which labels to include in the image. If blank, all labels will be included.

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

### `Optional`font

font?: string

Expression that evaluates to the fonts for the labels. If blank, a default system font will be used.

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

### height

height: number

Height of the generated image.

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

### `Optional`leader\_x\_column\_name

leader\_x\_column\_name?: string

Double, float or decimal expression that evaluates to the x coordinates of the points to which the labels' leader lines will be drawn. May be left blank if no leader lines are to be drawn.

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

### `Optional`leader\_y\_column\_name

leader\_y\_column\_name?: string

Double, float or decimal expression that evaluates to the y coordinates of the points to which the labels' leader lines will be drawn. May be left blank if no leader lines are to be drawn.

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

### `Optional`line\_color

line\_color?: string

Numeric expression that evaluates to the line color for the labels' boxes and leader lines. If blank, opaque black will be used.

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

### `Optional`line\_width

line\_width?: string

Numeric expression that evaluates to the line width in output pixels for the labels' boxes and leader lines. If blank, a line width of 1 will be used.

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

### max\_x

max\_x: number

Upper bound for the x coordinates of labels to include in the image.

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

### max\_y

max\_y: number

Upper bound for the y coordinates of labels to include in the image.

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

### min\_x

min\_x: number

Lower bound for the x coordinates of labels to include in the image.

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

### min\_y

min\_y: number

Lower bound for the y coordinates of labels to include in the image.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### `Optional`projection

projection?: string

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

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

### table\_name

table\_name: string

Name of the table containing the data defining the labels to render.

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

### `Optional`text\_angle

text\_angle?: string

Numeric expression that evaluates to the angle of clockwise rotation (in degrees) for the labels. If blank, an angle of 0 will be used.

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

### `Optional`text\_color

text\_color?: string

Numeric expression that evaluates to the text color for the labels. If blank, opaque black will be used.

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

### `Optional`text\_scale

text\_scale?: string

Numeric expression that evaluates to the scaling factor for the labels. (1 is normal size, 0.5 is half size, 2 is double size, etc.) If blank, a scaling factor of 1 will be used.

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

### text\_string

text\_string: string

Expression that evaluates to the text for the labels.

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

### width

width: number

Width of the generated image.

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

### x\_column\_name

x\_column\_name: string

Double, float or decimal expression that evaluates to the x coordinates of the center points of the labels.

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

### `Optional`x\_offset

x\_offset?: string

Numeric expression that evaluates to the number of output pixels by which the labels will be offset horizontally from their specified x coordinates. If blank, an offset of 0 will be used.

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

### y\_column\_name

y\_column\_name: string

Double, float or decimal expression that evaluates to the y coordinates of the center points of the labels.

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

### `Optional`y\_offset

y\_offset?: string

Numeric expression that evaluates to the number of output pixels by which the labels will be offset vertically from their specified y coordinates. If blank, an offset of 0 will be used.

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


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