Skip to main content
pub struct VisualizeImageLabelsRequest 

    pub table_name: String,
    pub x_column_name: String,
    pub y_column_name: String,
    pub x_offset: String,
    pub y_offset: String,
    pub text_string: String,
    pub font: String,
    pub text_color: String,
    pub text_angle: String,
    pub text_scale: String,
    pub draw_box: String,
    pub draw_leader: String,
    pub line_width: String,
    pub line_color: String,
    pub fill_color: String,
    pub leader_x_column_name: String,
    pub leader_y_column_name: String,
    pub filter: String,
    pub min_x: f64,
    pub max_x: f64,
    pub min_y: f64,
    pub max_y: f64,
    pub width: i32,
    pub height: i32,
    pub projection: String,
    pub options: HashMap<String, String>,

The request payload for the /visualize/image/labels endpoint.

Generate a rasterized image tile containing text labels

Fields

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

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

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

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

text_color: String

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

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.

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.

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.

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.

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.

fill_color: String

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

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.

filter: String

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

min_x: f64

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

max_x: f64

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

min_y: f64

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

max_y: f64

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

width: i32

Width of the generated image.

height: i32

Height of the generated image.

projection: String

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

options: HashMap<String, String>

Optional parameters.

Trait Implementations

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source

fn fmt(&self, f: &mut Formatter<’_>) -> Result

Formats the value using the given formatter. Read more
Source

fn deserialize<__D>(__deserializer: __D) ->Result<Self, __D::Error>
where __D: Deserializer<‘de>,

Deserialize this value from the given Serde deserializer. Read more
Source

fn avro_schema(&self) -> &‘static str

Returns the Avro schema as a JSON string for this record type.
Returns type properties including field types and attributes (e.g., primary_key).
Whether requests of this type are Snappy-compressed when the client has KineticaOptions::use_snappy enabled. Read more
Source

fn serialize<__S>(&self, __serializer: __S) ->Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more