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

<div className="kinetica-typedoc">
  <div className="section tsd-panel tsd-member">
    <h3 className="tsd-anchor-link" id="visualize_image_labels"><span>visualize\_image\_labels</span></h3>

    <ul className="tsd-signatures">
      <li className="">
        <div className="tsd-signature tsd-anchor-link" id="visualize_image_labels-1"><span className="tsd-kind-call-signature">visualize\_image\_labels</span><span className="tsd-signature-symbol">(</span><br /> <span className="tsd-kind-parameter">table\_name</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">x\_column\_name</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">y\_column\_name</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">x\_offset</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">y\_offset</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">text\_string</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">font</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">text\_color</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">text\_angle</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">text\_scale</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">draw\_box</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">draw\_leader</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">line\_width</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">line\_color</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">fill\_color</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">leader\_x\_column\_name</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">leader\_y\_column\_name</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">filter</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">min\_x</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">max\_x</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">min\_y</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">max\_y</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">width</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">height</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">projection</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">options</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">callback</span><span className="tsd-signature-symbol">?:</span> <a href="/content/api/nodejs/types/GPUdbCallback" className="tsd-signature-type tsd-kind-type-alias">GPUdbCallback</a><span className="tsd-signature-symbol">,</span><br /><span className="tsd-signature-symbol">)</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">Promise</span><span className="tsd-signature-symbol">\<</span><a href="/content/api/nodejs/interfaces/VisualizeImageLabelsResponse" className="tsd-signature-type tsd-kind-interface">VisualizeImageLabelsResponse</a><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-description">
          <div className="tsd-comment tsd-typography">
            <p>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 <code>visualize\_image</code>).</p>
            <p>All color values must be integers encoded in the format AARRGGBB when represented in hexadecimal.</p>
            <p>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.</p>
          </div>

          <div className="tsd-parameters">
            <h4 className="tsd-parameters-title">Parameters</h4>

            <ul className="tsd-parameter-list">
              <li>
                <span><span className="tsd-kind-parameter">table\_name</span>: <span className="tsd-signature-type">string</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Name of the table containing the data defining the labels to render.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">x\_column\_name</span>: <span className="tsd-signature-type">string</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Double, float or decimal expression that evaluates to the x coordinates of the center points of the labels.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">y\_column\_name</span>: <span className="tsd-signature-type">string</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Double, float or decimal expression that evaluates to the y coordinates of the center points of the labels.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">x\_offset</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>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.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">y\_offset</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>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.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">text\_string</span>: <span className="tsd-signature-type">string</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Expression that evaluates to the text for the labels.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">font</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Expression that evaluates to the fonts for the labels. If blank, a default system font will be used.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">text\_color</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Numeric expression that evaluates to the text color for the labels. If blank, opaque black will be used.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">text\_angle</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Numeric expression that evaluates to the angle of clockwise rotation (in degrees) for the labels. If blank, an angle of 0 will be used.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">text\_scale</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>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.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">draw\_box</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Boolean expression indicating whether boxes will be drawn around the labels. If blank, no boxes will be drawn.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">draw\_leader</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Boolean expression indicating whether leader lines will be drawn from the labels to points specified using <code>leader\_x\_column\_name</code> and <code>leader\_y\_column\_name</code>. If blank, no leader lines will be drawn.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">line\_width</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>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.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">line\_color</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Numeric expression that evaluates to the line color for the labels' boxes and leader lines. If blank, opaque black will be used.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">fill\_color</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Numeric expression that evaluates to the fill color for the labels' boxes. If blank, the boxes will not be filled.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">leader\_x\_column\_name</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>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.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">leader\_y\_column\_name</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>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.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">filter</span>: <span className="tsd-signature-type">string</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">undefined</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Boolean expression indicating which labels to include in the image. If blank, all labels will be included.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">min\_x</span>: <span className="tsd-signature-type">number</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Lower bound for the x coordinates of labels to include in the image.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">max\_x</span>: <span className="tsd-signature-type">number</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Upper bound for the x coordinates of labels to include in the image.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">min\_y</span>: <span className="tsd-signature-type">number</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Lower bound for the y coordinates of labels to include in the image.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">max\_y</span>: <span className="tsd-signature-type">number</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Upper bound for the y coordinates of labels to include in the image.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">width</span>: <span className="tsd-signature-type">number</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Width of the generated image.</p>
                </div>
              </li>

              <li>
                <span><span className="tsd-kind-parameter">height</span>: <span className="tsd-signature-type">number</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Height of the generated image.</p>
                </div>
              </li>

              <li>
                <span><code className="tsd-tag">Optional</code><span className="tsd-kind-parameter">projection</span>: <span className="tsd-signature-type">string</span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Spatial Reference System (i.e. EPSG Code).</p>
                </div>
              </li>

              <li>
                <span><code className="tsd-tag">Optional</code><span className="tsd-kind-parameter">options</span>: <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span></span>

                <div className="tsd-comment tsd-typography">
                  <p>Optional parameters.</p>
                </div>
              </li>

              <li>
                <span><code className="tsd-tag">Optional</code><span className="tsd-kind-parameter">callback</span>: <a href="/content/api/nodejs/types/GPUdbCallback" className="tsd-signature-type tsd-kind-type-alias">GPUdbCallback</a></span>

                <div className="tsd-comment tsd-typography">
                  <p>Optional callback function</p>
                </div>
              </li>
            </ul>
          </div>

          <h4 className="tsd-returns-title">Returns <span className="tsd-signature-type">Promise</span><span className="tsd-signature-symbol">\<</span><a href="/content/api/nodejs/interfaces/VisualizeImageLabelsResponse" className="tsd-signature-type tsd-kind-interface">VisualizeImageLabelsResponse</a><span className="tsd-signature-symbol">></span></h4>
          <p>Promise\<Types.VisualizeImageLabelsResponse> - Promise resolving to the response</p>

          <div className="aside tsd-sources">
            <ul>
              <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L15699">src/GPUdb.ts:15699</a></li>
            </ul>
          </div>
        </div>
      </li>
    </ul>
  </div>

  <div className="section tsd-panel tsd-member">
    <h3 className="tsd-anchor-link" id="visualize_image_labels_request"><span>visualize\_image\_labels\_request</span></h3>

    <ul className="tsd-signatures">
      <li className="">
        <div className="tsd-signature tsd-anchor-link" id="visualize_image_labels_request-1"><span className="tsd-kind-call-signature">visualize\_image\_labels\_request</span><span className="tsd-signature-symbol">(</span><br /> <span className="tsd-kind-parameter">request</span><span className="tsd-signature-symbol">:</span> <a href="/content/api/nodejs/interfaces/VisualizeImageLabelsRequest" className="tsd-signature-type tsd-kind-interface">VisualizeImageLabelsRequest</a><span className="tsd-signature-symbol">,</span><br /> <span className="tsd-kind-parameter">callback</span><span className="tsd-signature-symbol">?:</span> <a href="/content/api/nodejs/types/GPUdbCallback" className="tsd-signature-type tsd-kind-type-alias">GPUdbCallback</a><span className="tsd-signature-symbol">,</span><br /><span className="tsd-signature-symbol">)</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">Promise</span><span className="tsd-signature-symbol">\<</span><a href="/content/api/nodejs/interfaces/VisualizeImageLabelsResponse" className="tsd-signature-type tsd-kind-interface">VisualizeImageLabelsResponse</a><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-description">
          <div className="tsd-comment tsd-typography">
            <p>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 <code>visualize\_image</code>).</p>
            <p>All color values must be integers encoded in the format AARRGGBB when represented in hexadecimal.</p>
            <p>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.</p>
          </div>

          <div className="tsd-parameters">
            <h4 className="tsd-parameters-title">Parameters</h4>

            <ul className="tsd-parameter-list">
              <li>
                <span><span className="tsd-kind-parameter">request</span>: <a href="/content/api/nodejs/interfaces/VisualizeImageLabelsRequest" className="tsd-signature-type tsd-kind-interface">VisualizeImageLabelsRequest</a></span>

                <div className="tsd-comment tsd-typography">
                  <p>Request object containing the parameters for the operation</p>
                </div>
              </li>

              <li>
                <span><code className="tsd-tag">Optional</code><span className="tsd-kind-parameter">callback</span>: <a href="/content/api/nodejs/types/GPUdbCallback" className="tsd-signature-type tsd-kind-type-alias">GPUdbCallback</a></span>

                <div className="tsd-comment tsd-typography">
                  <p>Optional callback function</p>
                </div>
              </li>
            </ul>
          </div>

          <h4 className="tsd-returns-title">Returns <span className="tsd-signature-type">Promise</span><span className="tsd-signature-symbol">\<</span><a href="/content/api/nodejs/interfaces/VisualizeImageLabelsResponse" className="tsd-signature-type tsd-kind-interface">VisualizeImageLabelsResponse</a><span className="tsd-signature-symbol">></span></h4>
          <p>Promise\<Types.VisualizeImageLabelsResponse> - Promise resolving to the response</p>

          <div className="aside tsd-sources">
            <ul>
              <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L15612">src/GPUdb.ts:15612</a></li>
            </ul>
          </div>
        </div>
      </li>
    </ul>
  </div>
</div>


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