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

### visualize\_image\_labels

<ul>
  <li>
    visualize\_image\_labels(\
    &#x20;table\_name: string,\
    &#x20;x\_column\_name: string,\
    &#x20;y\_column\_name: string,\
    &#x20;x\_offset: string | undefined,\
    &#x20;y\_offset: string | undefined,\
    &#x20;text\_string: string,\
    &#x20;font: string | undefined,\
    &#x20;text\_color: string | undefined,\
    &#x20;text\_angle: string | undefined,\
    &#x20;text\_scale: string | undefined,\
    &#x20;draw\_box: string | undefined,\
    &#x20;draw\_leader: string | undefined,\
    &#x20;line\_width: string | undefined,\
    &#x20;line\_color: string | undefined,\
    &#x20;fill\_color: string | undefined,\
    &#x20;leader\_x\_column\_name: string | undefined,\
    &#x20;leader\_y\_column\_name: string | undefined,\
    &#x20;filter: string | undefined,\
    &#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,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[VisualizeImageLabelsResponse](https://docs.kinetica.com/content/api/typescript/interfaces/VisualizeImageLabelsResponse.md)>

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

    #### Parameters

    <ul>
      <li>
        table\_name: string

        Name of the table containing the data defining the labels to render.
      </li>

      <li>
        x\_column\_name: string

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

      <li>
        y\_column\_name: string

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

      <li>
        x\_offset: string | undefined

        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: string | undefined

        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: string

        Expression that evaluates to the text for the labels.
      </li>

      <li>
        font: string | undefined

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

      <li>
        text\_color: string | undefined

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

      <li>
        text\_angle: string | undefined

        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: string | undefined

        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: string | undefined

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

      <li>
        draw\_leader: string | undefined

        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: string | undefined

        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: string | undefined

        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: string | undefined

        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: string | undefined

        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: string | undefined

        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: string | undefined

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

      <li>
        min\_x: number

        Lower bound for the x coordinates of labels to include in the image.
      </li>

      <li>
        max\_x: number

        Upper bound for the x coordinates of labels to include in the image.
      </li>

      <li>
        min\_y: number

        Lower bound for the y coordinates of labels to include in the image.
      </li>

      <li>
        max\_y: number

        Upper bound for the y coordinates of labels to include in the image.
      </li>

      <li>
        width: number

        Width of the generated image.
      </li>

      <li>
        height: number

        Height of the generated image.
      </li>

      <li>
        `Optional`projection: string

        Spatial Reference System (i.e. EPSG Code).
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

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

        Optional callback function
      </li>
    </ul>

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

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

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

### visualize\_image\_labels\_request

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

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

    #### Parameters

    <ul>
      <li>
        request: [VisualizeImageLabelsRequest](https://docs.kinetica.com/content/api/typescript/interfaces/VisualizeImageLabelsRequest.md)

        Request object containing the parameters for the operation
      </li>

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

        Optional callback function
      </li>
    </ul>

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

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

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


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