GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::VisualizeImageChartRequest Struct Reference

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.
[in]options_Optional parameters.

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: