Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
VisualizeImageChart.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 
10 
11 namespace kinetica
12 {
13 
25  {
26 
214  public struct StyleOptions
215  {
216 
219  public const string POINTCOLOR = "pointcolor";
220 
223  public const string POINTSIZE = "pointsize";
224 
259  public const string POINTSHAPE = "pointshape";
260 
262  public const string NONE = "none";
263  public const string CIRCLE = "circle";
264  public const string SQUARE = "square";
265  public const string DIAMOND = "diamond";
266  public const string HOLLOWCIRCLE = "hollowcircle";
267  public const string HOLLOWSQUARE = "hollowsquare";
268  public const string HOLLOWDIAMOND = "hollowdiamond";
269 
278  public const string CB_POINTCOLORS = "cb_pointcolors";
279 
287  public const string CB_POINTSIZES = "cb_pointsizes";
288 
296  public const string CB_POINTSHAPES = "cb_pointshapes";
297 
301  public const string CB_DELIMITER = "cb_delimiter";
302 
306  public const string X_ORDER_BY = "x_order_by";
307 
311  public const string Y_ORDER_BY = "y_order_by";
312 
331  public const string SCALE_TYPE_X = "scale_type_x";
332 
335  public const string LOG = "log";
336 
355  public const string SCALE_TYPE_Y = "scale_type_y";
356 
365  public const string MIN_MAX_SCALED = "min_max_scaled";
366 
369  public const string JITTER_X = "jitter_x";
370 
373  public const string JITTER_Y = "jitter_y";
374 
378  public const string PLOT_ALL = "plot_all";
379  } // end struct StyleOptions
380 
381 
412  public struct Options
413  {
414 
435  public const string IMAGE_ENCODING = "image_encoding";
436 
438  public const string BASE64 = "base64";
439 
442  public const string NONE = "none";
443  } // end struct Options
444 
445 
450  public string table_name { get; set; }
451 
454  public IList<string> x_column_names { get; set; } = new List<string>();
455 
458  public IList<string> y_column_names { get; set; } = new List<string>();
459 
463  public double min_x { get; set; }
464 
468  public double max_x { get; set; }
469 
473  public double min_y { get; set; }
474 
478  public double max_y { get; set; }
479 
481  public int width { get; set; }
482 
484  public int height { get; set; }
485 
487  public string bg_color { get; set; }
488 
674  public IDictionary<string, IList<string>> style_options { get; set; } = new Dictionary<string, IList<string>>();
675 
704  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
705 
706 
710 
955  IList<string> x_column_names,
956  IList<string> y_column_names,
957  double min_x,
958  double max_x,
959  double min_y,
960  double max_y,
961  int width,
962  int height,
963  string bg_color,
964  IDictionary<string, IList<string>> style_options,
965  IDictionary<string, string> options = null)
966  {
967  this.table_name = table_name ?? "";
968  this.x_column_names = x_column_names ?? new List<string>();
969  this.y_column_names = y_column_names ?? new List<string>();
970  this.min_x = min_x;
971  this.max_x = max_x;
972  this.min_y = min_y;
973  this.max_y = max_y;
974  this.width = width;
975  this.height = height;
976  this.bg_color = bg_color ?? "";
977  this.style_options = style_options ?? new Dictionary<string, IList<string>>();
978  this.options = options ?? new Dictionary<string, string>();
979  } // end constructor
980 
981  } // end class VisualizeImageChartRequest
982 
983 
984 
989  {
990 
1022  public struct AxesInfo
1023  {
1024 
1027  public const string SORTED_X_VALUES = "sorted_x_values";
1028 
1031  public const string LOCATION_X = "location_x";
1032 
1035  public const string SORTED_Y_VALUES = "sorted_y_values";
1036 
1039  public const string LOCATION_Y = "location_y";
1040  } // end struct AxesInfo
1041 
1042 
1046  public double min_x { get; set; }
1047 
1051  public double max_x { get; set; }
1052 
1056  public double min_y { get; set; }
1057 
1061  public double max_y { get; set; }
1062 
1065  public int width { get; set; }
1066 
1069  public int height { get; set; }
1070 
1073  public string bg_color { get; set; }
1074 
1076  public byte[] image_data { get; set; }
1077 
1107  public IDictionary<string, IList<string>> axes_info { get; set; } = new Dictionary<string, IList<string>>();
1108 
1110  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1111 
1112  } // end class VisualizeImageChartResponse
1113 
1114 
1115 
1116 
1117 } // end namespace kinetica
const string LOG
A base-10 log scale is applied to the y axis.
const string MIN_MAX_SCALED
If this options is set to &quot;false&quot;, this endpoint expects request&#39;s min/max values are not yet scale...
double min_y
Lower bound for the y column values as provided in or calculated for non-numeric columns when plot_a...
int height
Height of the generated image in pixels.
const string CB_POINTCOLORS
Point color class break information consisting of three entries: class-break attribute, class-break values/ranges, and point color values.
A set of results returned by Kinetica.visualizeImageChart(string,IList{string},IList{string},double,double,double,double,int,int,string,IDictionary{string, IList{string}},IDictionary{string, string}).
const string POINTSHAPE
The shape of points in the plot.
IDictionary< string, IList< string > > style_options
Rendering style options for a chart.
const string JITTER_X
Amplitude of horizontal jitter applied to non-numeric x column values.
IList< string > y_column_names
Names of the columns containing the data mapped to the y axis of a chart.
IDictionary< string, string > info
Additional information.
int width
Width of the generated image in pixels.
const string NONE
Do not apply any additional encoding to the output image.
int height
Height of the image as provided in .
IDictionary< string, IList< string > > axes_info
Information returned for drawing labels for the axes associated with non-numeric columns.
double min_x
Lower bound for the x column values.
const string POINTCOLOR
The color of points in the plot represented as a hexadecimal number.
const string JITTER_Y
Amplitude of vertical jitter applied to non-numeric y column values.
VisualizeImageChartRequest(string table_name, IList< string > x_column_names, IList< string > y_column_names, double min_x, double max_x, double min_y, double max_y, int width, int height, string bg_color, IDictionary< string, IList< string >> style_options, IDictionary< string, string > options=null)
Constructs a VisualizeImageChartRequest object with the specified parameters.
const string LOCATION_Y
Y axis label positions of sorted_y_values in pixel coordinates.
int width
Width of the image as provided in .
const string SORTED_X_VALUES
Sorted non-numeric x column value list for drawing x axis label.
VisualizeImageChartRequest()
Constructs a VisualizeImageChartRequest object with default parameters.
const string LOCATION_X
X axis label positions of sorted_x_values in pixel coordinates.
Information returned for drawing labels for the axes associated with non-numeric columns.
double min_y
Lower bound for the y column values.
byte[] image_data
The generated image data.
double max_y
Upper bound for the y column values.
IDictionary< string, string > options
Optional parameters.
const string SCALE_TYPE_Y
Type of y axis scale.
const string SORTED_Y_VALUES
Sorted non-numeric y column value list for drawing y axis label.
IList< string > x_column_names
Names of the columns containing the data mapped to the x axis of a chart.
double max_x
Upper bound for the x column values.
const string CB_POINTSHAPES
Point shape class break information consisting of three entries: class-break attribute, class-break values/ranges, and point shape names.
double max_x
Upper bound for the x column values as provided in or calculated for non-numeric columns when plot_a...
const string SCALE_TYPE_X
Type of x axis scale.
const string PLOT_ALL
If this options is set to &quot;true&quot;, all non-numeric column values are plotted ignoring min_x...
const string BASE64
Apply base64 encoding to the output image.
double min_x
Lower bound for the x column values as provided in or calculated for non-numeric columns when plot_a...
const string POINTSIZE
The size of points in the plot represented as number of pixels.
const string NONE
No scale is applied to the y axis.
string bg_color
Background color of the generated image.
const string IMAGE_ENCODING
Encoding to be applied to the output image.
double max_y
Upper bound for the y column values as provided in or calculated for non-numeric columns when plot_a...
const string Y_ORDER_BY
An expression or aggregate expression by which non-numeric y column values are sorted, e.g.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string CB_DELIMITER
A character or string which separates per-class values in a class-break style option string...
A set of parameters for Kinetica.visualizeImageChart(string,IList{string},IList{string},double,double,double,double,int,int,string,IDictionary{string, IList{string}},IDictionary{string, string}).
string table_name
Name of the table containing the data to be drawn as a chart, in [schema_name.
const string CB_POINTSIZES
Point size class break information consisting of three entries: class-break attribute, class-break values/ranges, and point size values.
const string X_ORDER_BY
An expression or aggregate expression by which non-numeric x column values are sorted, e.g.
string bg_color
Background color of the image as provided in .