Skip to main content

  • 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

    • table_name: string

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

    • x_column_name: string

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

    • y_column_name: string

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

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

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

    • text_string: string

      Expression that evaluates to the text for the labels.

    • font: string | undefined

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

    • text_color: string | undefined

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

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

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

    • draw_box: string | undefined

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

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

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

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

    • fill_color: string | undefined

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

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

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

    • filter: string | undefined

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

    • min_x: number

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

    • max_x: number

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

    • min_y: number

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

    • max_y: number

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

    • width: number

      Width of the generated image.

    • height: number

      Height of the generated image.

    • Optionalprojection: string

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

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    ​
    Returns Promise<VisualizeImageLabelsResponse>

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

  • 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

    ​
    Returns Promise<VisualizeImageLabelsResponse>

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