Skip to main content

Constants for the fields of the /visualize/image/chart request.

Option fields

options

Constants for options.

pub const BASE64: &str = “base64”;

Apply base64 encoding to the output image.

pub const IMAGE_ENCODING: &str = “image_encoding”;

Encoding to be applied to the output image. When using JSON serialization it is recommended to specify this as base64.

pub const NONE: &str = “none”;

Do not apply any additional encoding to the output image.

style_options

Constants for style_options.

pub const CB_DELIMITER: &str = “cb_delimiter”;

A character or string which separates per-class values in a class-break style option string.

pub const CB_POINTCOLORS: &str = “cb_pointcolors”;

Point color class break information consisting of three entries: class-break attribute, class-break values/ranges, and point color values. This option overrides the pointcolor option if both are provided. Class-break ranges are represented in the form of “min:max”. Class-break values/ranges and point color values are separated by cb_delimiter, e.g. “price”, “20:30;30:40;40:50”, “0xFF0000;0x00FF00;0x0000FF”.

pub const CB_POINTSHAPES: &str = “cb_pointshapes”;

Point shape class break information consisting of three entries: class-break attribute, class-break values/ranges, and point shape names. This option overrides the pointshape option if both are provided. Class-break ranges are represented in the form of “min:max”. Class-break values/ranges and point shape names are separated by cb_delimiter, e.g. “states”, “NY;TX;CA”, “circle;square;diamond”.

pub const CB_POINTSIZES: &str = “cb_pointsizes”;

Point size class break information consisting of three entries: class-break attribute, class-break values/ranges, and point size values. This option overrides the pointsize option if both are provided. Class-break ranges are represented in the form of “min:max”. Class-break values/ranges and point size values are separated by cb_delimiter, e.g. “states”, “NY;TX;CA”, “3;5;7”.

pub const CIRCLE: &str = “circle”;
pub const DIAMOND: &str = “diamond”;
pub const HOLLOWCIRCLE: &str = “hollowcircle”;
pub const HOLLOWDIAMOND: &str = “hollowdiamond”;
pub const HOLLOWSQUARE: &str = “hollowsquare”;
pub const JITTER_X: &str = “jitter_x”;

Amplitude of horizontal jitter applied to non-numeric x column values.

pub const JITTER_Y: &str = “jitter_y”;

Amplitude of vertical jitter applied to non-numeric y column values.

pub const LOG: &str = “log”;

A base-10 log scale is applied to the y axis.

pub const MIN_MAX_SCALED: &str = “min_max_scaled”;

If this options is set to false, this endpoint expects request’s min/max values are not yet scaled. They will be scaled according to scale_type_x or scale_type_y for response. If this options is set to true, this endpoint expects request’s min/max values are already scaled according to scale_type_x/scale_type_y. Response’s min/max values will be equal to request’s min/max values.

pub const NONE: &str = “none”;

No scale is applied to the y axis.

pub const PLOT_ALL: &str = “plot_all”;

If this options is set to true, all non-numeric column values are plotted ignoring min_x, max_x, min_y and max_y parameters.

pub const POINTCOLOR: &str = “pointcolor”;

The color of points in the plot represented as a hexadecimal number.

pub const POINTSHAPE: &str = “pointshape”;

The shape of points in the plot.

pub const POINTSIZE: &str = “pointsize”;

The size of points in the plot represented as number of pixels.

pub const SCALE_TYPE_X: &str = “scale_type_x”;

Type of x axis scale.

pub const SCALE_TYPE_Y: &str = “scale_type_y”;

Type of y axis scale.

pub const SQUARE: &str = “square”;
pub const X_ORDER_BY: &str = “x_order_by”;

An expression or aggregate expression by which non-numeric x column values are sorted, e.g. “avg(price) descending”.

pub const Y_ORDER_BY: &str = “y_order_by”;

An expression or aggregate expression by which non-numeric y column values are sorted, e.g. “avg(price)”, which defaults to “avg(price) ascending”.