A set of input parameters for const. More...

#include <gpudb/protocol/visualize_image_chart.h>

Public Member Functions
	VisualizeImageChartRequest ()
	Constructs a VisualizeImageChartRequest object with default parameter values. More...

	VisualizeImageChartRequest (const std::string &tableName_, const std::vector< std::string > &xColumnNames_, const std::vector< std::string > &yColumnNames_, const double minX_, const double maxX_, const double minY_, const double maxY_, const int32_t width_, const int32_t height_, const std::string &bgColor_, const std::map< std::string, std::vector< std::string > > &styleOptions_, const std::map< std::string, std::string > &options_)
	Constructs a VisualizeImageChartRequest object with the specified parameters. More...

Public Attributes
std::string	tableName

std::vector< std::string >	xColumnNames

std::vector< std::string >	yColumnNames

double	minX

double	maxX

double	minY

double	maxY

int32_t	width

int32_t	height

std::string	bgColor

std::map< std::string, std::vector< std::string > >	styleOptions

std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

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 imageData field.

Definition at line 22 of file visualize_image_chart.h.

Constructor & Destructor Documentation

gpudb::VisualizeImageChartRequest::VisualizeImageChartRequest ( )

inline

Constructs a VisualizeImageChartRequest object with default parameter values.

Definition at line 29 of file visualize_image_chart.h.

gpudb::VisualizeImageChartRequest::VisualizeImageChartRequest	(	const std::string &	tableName_,
		const std::vector< std::string > &	xColumnNames_,
		const std::vector< std::string > &	yColumnNames_,
		const double	minX_,
		const double	maxX_,
		const double	minY_,
		const double	maxY_,
		const int32_t	width_,
		const int32_t	height_,
		const std::string &	bgColor_,
		const std::map< std::string, std::vector< std::string > > &	styleOptions_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a VisualizeImageChartRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table containing the data to be drawn as a chart.
[in]	xColumnNames_	Names of the columns containing the data mapped to the x axis of a chart.
[in]	yColumnNames_	Names of the columns containing the data mapped to the y axis of a chart.
[in]	minX_	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.
[in]	maxX_	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.
[in]	minY_	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.
[in]	maxY_	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.
[in]	width_	Width of the generated image in pixels.
[in]	height_	Height of the generated image in pixels.
[in]	bgColor_	Background color of the generated image.
[in]	styleOptions_	Rendering style options for a chart. gpudb::visualize_image_chart_pointcolor: The color of points in the plot represented as a hexadecimal number. The default value is '0000FF'. gpudb::visualize_image_chart_pointsize: The size of points in the plot represented as number of pixels. The default value is '3'. gpudb::visualize_image_chart_pointshape: The shape of points in the plot. gpudb::visualize_image_chart_none gpudb::visualize_image_chart_circle gpudb::visualize_image_chart_square gpudb::visualize_image_chart_diamond gpudb::visualize_image_chart_hollowcircle gpudb::visualize_image_chart_hollowsquare gpudb::visualize_image_chart_hollowdiamond The default value is gpudb::visualize_image_chart_square. gpudb::visualize_image_chart_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"}. gpudb::visualize_image_chart_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"}. gpudb::visualize_image_chart_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"}. gpudb::visualize_image_chart_cb_delimiter: A character or string which separates per-class values in a class-break style option string. The default value is ';'. gpudb::visualize_image_chart_x_order_by: An expression or aggregate expression by which non-numeric x column values are sorted, e.g. "avg(price) descending". gpudb::visualize_image_chart_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". gpudb::visualize_image_chart_scale_type_x: Type of x axis scale. gpudb::visualize_image_chart_none: No scale is applied to the x axis. gpudb::visualize_image_chart_log: A base-10 log scale is applied to the x axis. The default value is gpudb::visualize_image_chart_none. gpudb::visualize_image_chart_scale_type_y: Type of y axis scale. gpudb::visualize_image_chart_none: No scale is applied to the y axis. gpudb::visualize_image_chart_log: A base-10 log scale is applied to the y axis. The default value is gpudb::visualize_image_chart_none. gpudb::visualize_image_chart_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. The default value is 'false'. gpudb::visualize_image_chart_jitter_x: Amplitude of horizontal jitter applied to non-numeric x column values. The default value is '0.0'. gpudb::visualize_image_chart_jitter_y: Amplitude of vertical jitter applied to non-numeric y column values. The default value is '0.0'. gpudb::visualize_image_chart_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. The default value is 'false'.
[in]	options_	Optional parameters. gpudb::visualize_image_chart_image_encoding: Encoding to be applied to the output image. When using JSON serialization it is recommended to specify this as base64. gpudb::visualize_image_chart_base64: Apply base64 encoding to the output image. gpudb::visualize_image_chart_none: Do not apply any additional encoding to the output image. The default value is gpudb::visualize_image_chart_none.

Definition at line 235 of file visualize_image_chart.h.

Member Data Documentation

std::string gpudb::VisualizeImageChartRequest::bgColor

Definition at line 260 of file visualize_image_chart.h.

int32_t gpudb::VisualizeImageChartRequest::height

Definition at line 259 of file visualize_image_chart.h.

double gpudb::VisualizeImageChartRequest::maxX

Definition at line 255 of file visualize_image_chart.h.

double gpudb::VisualizeImageChartRequest::maxY

Definition at line 257 of file visualize_image_chart.h.

double gpudb::VisualizeImageChartRequest::minX

Definition at line 254 of file visualize_image_chart.h.

double gpudb::VisualizeImageChartRequest::minY

Definition at line 256 of file visualize_image_chart.h.

std::map<std::string, std::string> gpudb::VisualizeImageChartRequest::options

Definition at line 262 of file visualize_image_chart.h.

std::map<std::string, std::vector<std::string> > gpudb::VisualizeImageChartRequest::styleOptions

Definition at line 261 of file visualize_image_chart.h.

std::string gpudb::VisualizeImageChartRequest::tableName

Definition at line 251 of file visualize_image_chart.h.

int32_t gpudb::VisualizeImageChartRequest::width

Definition at line 258 of file visualize_image_chart.h.

std::vector<std::string> gpudb::VisualizeImageChartRequest::xColumnNames

Definition at line 252 of file visualize_image_chart.h.

std::vector<std::string> gpudb::VisualizeImageChartRequest::yColumnNames

Definition at line 253 of file visualize_image_chart.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/visualize_image_chart.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation