/visualize/image/chart
URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/visualize/image/chart
Scatter plot is the only plot type currently supported. A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value).
The image is contained in the output parameter image_data field.
| Name |
Type |
Description |
|---|
| table_name |
string |
Name of the table containing the data to be drawn as a chart. |
| x_column_name |
string |
Name of the column containing the data mapped to the x axis of a chart. |
| y_column_name |
string |
Name of the column containing the data mapped to the y axis of a chart. |
| min_x |
double |
Lower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. |
| max_x |
double |
Upper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. |
| min_y |
double |
Lower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. |
| max_y |
double |
Upper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. |
| width |
int |
Width of the generated image in pixels. |
| height |
int |
Height of the generated image in pixels. |
| bg_color |
string |
Background color of the generated image. |
| style_options |
map of
string
to
arrays
of
strings |
Rendering style options for a chart.
| Supported
Parameters
(keys) |
Parameter Description |
|---|
| pointcolor |
The color of points in the plot represented as a hexadecimal number. Default value is '0000FF'. |
| pointsize |
The size of points in the plot represented as number of pixels. Default value is '3'. The minimum allowed value is 0. The maximum allowed value is 20. |
| pointshape |
The shape of points in the plot. Default value is 'square'. The allowed values are:
- none
- circle
- square
- diamond
- hollowcircle
- hollowsquare
- hollowdiamond
|
| 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"}. |
| 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"}. |
| 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"}. |
| cb_delimiter |
A character or string which separates per-class values in a class-break style option string. Default value is ';'. |
| x_order_by |
An expression or aggregate expression by which non-numeric x column values are sorted, e.g. "avg(price) descending". |
| 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". |
| jitter_x |
Amplitude of horizontal jitter applied to non-numaric x column values. Default value is '0.0'. The minimum allowed value is 0.0. The maximum allowed value is 1.0. |
| jitter_y |
Amplitude of vertical jitter applied to non-numaric y column values. Default value is '0.0'. The minimum allowed value is 0.0. The maximum allowed value is 1.0. |
| 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. Default value is 'false'. |
|
| options |
map of
string
to
strings |
Optional parameters. Default value is an empty map ( {} ). |
The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
| Name |
Type |
Description |
|---|
| status |
String |
'OK' or 'ERROR' |
| message |
String |
Empty if success or an error message |
| data_type |
String |
'visualize_image_chart_request' or 'none' in case of an error |
| data |
String |
Empty string |
| data_str |
JSON
or
String |
This embedded JSON represents the result of the /visualize/image/chart endpoint:
| Name |
Type |
Description |
|---|
| min_x |
double |
Lower bound for the x column values as provided in input parameter min_x or
calculated for non-numeric columns when plot_all option is used. |
| max_x |
double |
Upper bound for the x column values as provided in input parameter max_x or
calculated for non-numeric columns when plot_all option is used. |
| min_y |
double |
Lower bound for the y column values as provided in input parameter min_y or
calculated for non-numeric columns when plot_all option is used. |
| max_y |
double |
Upper bound for the y column values as provided in input parameter max_y or
calculated for non-numeric columns when plot_all option is used. |
| width |
int |
Width of the image as provided in input parameter width. |
| height |
int |
Height of the image as provided in input parameter height. |
| bg_color |
string |
Background color of the image as provided in input parameter bg_color. |
| image_data |
bytes |
The generated image data. |
| axes_info |
map of
string
to
arrays
of
strings |
Information returned for drawing labels for the axes associated with non-numeric
columns.
| Supported
Parameters
(keys) |
Parameter Description |
|---|
| sorted_x_values |
Sorted non-numeric x column value list for drawing x axis label. |
| location_x |
X axis label positions of sorted_x_values in pixel coordinates. |
| sorted_y_values |
Sorted non-numeric y column value list for drawing y axis label. |
| location_y |
Y axis label positions of sorted_y_values in pixel coordinates. |
|
Empty string in case of an error.
|
