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

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/visualize_image_labels.rs#L92-L149)
pub async fn [visualize\_image\_labels](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/visualize-image-labels.md#method.visualize_image_labels)( \&self, table\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), x\_column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), y\_column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), x\_offset: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), y\_offset: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), text\_string: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), font: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), text\_color: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), text\_angle: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), text\_scale: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), draw\_box: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), draw\_leader: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), line\_width: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), line\_color: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), fill\_color: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), leader\_x\_column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), leader\_y\_column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), filter: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), min\_x: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), max\_x: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), min\_y: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), max\_y: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), width: [i32](https://doc.rust-lang.org/1.98.1/std/primitive.i32.html), height: [i32](https://doc.rust-lang.org/1.98.1/std/primitive.i32.html), projection: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[VisualizeImageLabelsResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.VisualizeImageLabelsResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Generate a rasterized image tile containing text labelsFor internal use only. Generates a rasterized image tile containing text labels defined by data contained in the given table, suitable for overlaying onto a feature image tile covering the same area (for example one generated using `/visualize/image`).All color values must be integers encoded in the format AARRGGBB when represented in hexadecimal.Fonts are specified as strings of the form ‘FAMILY STYLE-OPTIONS SIZE’, where FAMILY is the font family, STYLE-OPTIONS is a whitespace separated list of words defining style, variant, weight, stretch, or gravity, and SIZE is a decimal number (size in points) or optionally followed by the unit modifier ‘px’ for absolute size. All three sub-fields are optional; default values will be used for omitted sub-fields. (For example, ‘Helvetica Bold Italic 10’ specifies Helvetica, Bold and Italic, 10 points.) A substitute font will be used if a requested font is not installed.

##### Arguments

<ul>
  <li>`table_name` - Name of the table containing the data defining the labels to render.</li>
  <li>`x_column_name` - Double, float or decimal expression that evaluates to the x coordinates of the center points of the labels.</li>
  <li>`y_column_name` - Double, float or decimal expression that evaluates to the y coordinates of the center points of the labels.</li>
  <li>`x_offset` - 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.</li>
  <li>`y_offset` - 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.</li>
  <li>`text_string` - Expression that evaluates to the text for the labels.</li>
  <li>`font` - Expression that evaluates to the fonts for the labels. If blank, a default system font will be used.</li>
  <li>`text_color` - Numeric expression that evaluates to the text color for the labels. If blank, opaque black will be used.</li>
  <li>`text_angle` - Numeric expression that evaluates to the angle of clockwise rotation (in degrees) for the labels. If blank, an angle of 0 will be used.</li>
  <li>`text_scale` - 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.</li>
  <li>`draw_box` - Boolean expression indicating whether boxes will be drawn around the labels. If blank, no boxes will be drawn.</li>
  <li>`draw_leader` - 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.</li>
  <li>`line_width` - 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.</li>
  <li>`line_color` - Numeric expression that evaluates to the line color for the labels’ boxes and leader lines. If blank, opaque black will be used.</li>
  <li>`fill_color` - Numeric expression that evaluates to the fill color for the labels’ boxes. If blank, the boxes will not be filled.</li>
  <li>`leader_x_column_name` - 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.</li>
  <li>`leader_y_column_name` - 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.</li>
  <li>`filter` - Boolean expression indicating which labels to include in the image. If blank, all labels will be included.</li>
  <li>`min_x` - Lower bound for the x coordinates of labels to include in the image.</li>
  <li>`max_x` - Upper bound for the x coordinates of labels to include in the image.</li>
  <li>`min_y` - Lower bound for the y coordinates of labels to include in the image.</li>
  <li>`max_y` - Upper bound for the y coordinates of labels to include in the image.</li>
  <li>`width` - Width of the generated image.</li>
  <li>`height` - Height of the generated image.</li>
  <li>`projection` - Spatial Reference System (i.e. EPSG Code).</li>
</ul>

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/visualize_image_labels.rs#L233-L297)
pub async fn [visualize\_image\_labels\_with\_opts](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/visualize-image-labels.md#method.visualize_image_labels_with_opts)( \&self, table\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), x\_column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), y\_column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), x\_offset: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), y\_offset: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), text\_string: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), font: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), text\_color: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), text\_angle: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), text\_scale: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), draw\_box: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), draw\_leader: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), line\_width: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), line\_color: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), fill\_color: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), leader\_x\_column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), leader\_y\_column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), filter: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), min\_x: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), max\_x: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), min\_y: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), max\_y: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), width: [i32](https://doc.rust-lang.org/1.98.1/std/primitive.i32.html), height: [i32](https://doc.rust-lang.org/1.98.1/std/primitive.i32.html), projection: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), options: [VisualizeImageLabelsRequestOptions](https://docs.kinetica.com/content/api/rust/generated/api/struct.VisualizeImageLabelsRequestOptions.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[VisualizeImageLabelsResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.VisualizeImageLabelsResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Generate a rasterized image tile containing text labelsFor internal use only. Generates a rasterized image tile containing text labels defined by data contained in the given table, suitable for overlaying onto a feature image tile covering the same area (for example one generated using `/visualize/image`).All color values must be integers encoded in the format AARRGGBB when represented in hexadecimal.Fonts are specified as strings of the form ‘FAMILY STYLE-OPTIONS SIZE’, where FAMILY is the font family, STYLE-OPTIONS is a whitespace separated list of words defining style, variant, weight, stretch, or gravity, and SIZE is a decimal number (size in points) or optionally followed by the unit modifier ‘px’ for absolute size. All three sub-fields are optional; default values will be used for omitted sub-fields. (For example, ‘Helvetica Bold Italic 10’ specifies Helvetica, Bold and Italic, 10 points.) A substitute font will be used if a requested font is not installed.

##### Arguments

<ul>
  <li>`table_name` - Name of the table containing the data defining the labels to render.</li>
  <li>`x_column_name` - Double, float or decimal expression that evaluates to the x coordinates of the center points of the labels.</li>
  <li>`y_column_name` - Double, float or decimal expression that evaluates to the y coordinates of the center points of the labels.</li>
  <li>`x_offset` - 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.</li>
  <li>`y_offset` - 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.</li>
  <li>`text_string` - Expression that evaluates to the text for the labels.</li>
  <li>`font` - Expression that evaluates to the fonts for the labels. If blank, a default system font will be used.</li>
  <li>`text_color` - Numeric expression that evaluates to the text color for the labels. If blank, opaque black will be used.</li>
  <li>`text_angle` - Numeric expression that evaluates to the angle of clockwise rotation (in degrees) for the labels. If blank, an angle of 0 will be used.</li>
  <li>`text_scale` - 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.</li>
  <li>`draw_box` - Boolean expression indicating whether boxes will be drawn around the labels. If blank, no boxes will be drawn.</li>
  <li>`draw_leader` - 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.</li>
  <li>`line_width` - 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.</li>
  <li>`line_color` - Numeric expression that evaluates to the line color for the labels’ boxes and leader lines. If blank, opaque black will be used.</li>
  <li>`fill_color` - Numeric expression that evaluates to the fill color for the labels’ boxes. If blank, the boxes will not be filled.</li>
  <li>`leader_x_column_name` - 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.</li>
  <li>`leader_y_column_name` - 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.</li>
  <li>`filter` - Boolean expression indicating which labels to include in the image. If blank, all labels will be included.</li>
  <li>`min_x` - Lower bound for the x coordinates of labels to include in the image.</li>
  <li>`max_x` - Upper bound for the x coordinates of labels to include in the image.</li>
  <li>`min_y` - Lower bound for the y coordinates of labels to include in the image.</li>
  <li>`max_y` - Upper bound for the y coordinates of labels to include in the image.</li>
  <li>`width` - Width of the generated image.</li>
  <li>`height` - Height of the generated image.</li>
  <li>`projection` - Spatial Reference System (i.e. EPSG Code).</li>
  <li>`options` - The optional parameters; any left unset take the server’s defaults.</li>
</ul>

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/visualize_image_labels.rs#L300-L311)
pub async fn [visualize\_image\_labels\_raw](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/visualize-image-labels.md#method.visualize_image_labels_raw)( \&self, request: &[VisualizeImageLabelsRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.VisualizeImageLabelsRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[VisualizeImageLabelsResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.VisualizeImageLabelsResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Sends a pre-built [`VisualizeImageLabelsRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.VisualizeImageLabelsRequest) to the `/visualize/image/labels` endpoint.

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/visualize_image_labels.rs#L315-L327)
pub async fn [visualize\_image\_labels\_from\_url](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/visualize-image-labels.md#method.visualize_image_labels_from_url)( \&self, url: &[str](https://doc.rust-lang.org/1.98.1/std/primitive.str.html), request: &[VisualizeImageLabelsRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.VisualizeImageLabelsRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[VisualizeImageLabelsResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.VisualizeImageLabelsResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Sends a pre-built [`VisualizeImageLabelsRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.VisualizeImageLabelsRequest) to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.


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