Skip to main content
interface VisualizeImageLabelsRequest
draw_box?: string;
draw_leader?: string;
fill_color?: string;
filter?: string;
font?: string;
height: number;
leader_x_column_name?: string;
leader_y_column_name?: string;
line_color?: string;
line_width?: string;
max_x: number;
max_y: number;
min_x: number;
min_y: number;
options?: Record<string, string>;
projection?: string;
table_name: string;
text_angle?: string;
text_color?: string;
text_scale?: string;
text_string: string;
width: number;
x_column_name: string;
x_offset?: string;
y_column_name: string;
y_offset?: string;
draw_box? draw_leader? fill_color? filter? font? height leader_x_column_name? leader_y_column_name? line_color? line_width? max_x max_y min_x min_y options? projection? table_name text_angle? text_color? text_scale? text_string width x_column_name x_offset? y_column_name y_offset?
draw_box?: string

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

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.

fill_color?: string

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

filter?: string

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

font?: string

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

height: number

Height of the generated image.

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.

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.

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.

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.

max_x: number

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

max_y: number

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

min_x: number

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

options?: Record<string, string>

Optional parameters.

projection?: string

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

table_name: string

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

​
Optionaltext_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.

​
Optionaltext_color

text_color?: string

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

​
Optionaltext_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.

​
text_string

text_string: string

Expression that evaluates to the text for the labels.

width: number

Width of the generated image.

x_column_name: string

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

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.

y_column_name: string

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

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.