Kinetica   C#   API  Version 7.2.3.1
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 namespace kinetica;
10 
22 {
26  public struct StyleOptions
27  {
31  public const string POINTCOLOR = "pointcolor";
32 
36  public const string POINTSIZE = "pointsize";
37 
69  public const string POINTSHAPE = "pointshape";
70 
72  public const string NONE = "none";
73 
74  public const string CIRCLE = "circle";
75  public const string SQUARE = "square";
76  public const string DIAMOND = "diamond";
77  public const string HOLLOWCIRCLE = "hollowcircle";
78  public const string HOLLOWSQUARE = "hollowsquare";
79  public const string HOLLOWDIAMOND = "hollowdiamond";
80 
89  public const string CB_POINTCOLORS = "cb_pointcolors";
90 
99  public const string CB_POINTSIZES = "cb_pointsizes";
100 
109  public const string CB_POINTSHAPES = "cb_pointshapes";
110 
114  public const string CB_DELIMITER = "cb_delimiter";
115 
118  public const string X_ORDER_BY = "x_order_by";
119 
123  public const string Y_ORDER_BY = "y_order_by";
124 
141  public const string SCALE_TYPE_X = "scale_type_x";
142 
144  public const string LOG = "log";
145 
162  public const string SCALE_TYPE_Y = "scale_type_y";
163 
172  public const string MIN_MAX_SCALED = "min_max_scaled";
173 
177  public const string JITTER_X = "jitter_x";
178 
182  public const string JITTER_Y = "jitter_y";
183 
188  public const string PLOT_ALL = "plot_all";
189  } // end struct StyleOptions
190 
194  public struct Options
195  {
212  public const string IMAGE_ENCODING = "image_encoding";
213 
215  public const string BASE64 = "base64";
216 
219  public const string NONE = "none";
220  } // end struct Options
221 
226  public string table_name { get; set; }
227 
230  public IList<string> x_column_names { get; set; } = new List<string>();
231 
234  public IList<string> y_column_names { get; set; } = new List<string>();
235 
239  public double min_x { get; set; }
240 
244  public double max_x { get; set; }
245 
249  public double min_y { get; set; }
250 
254  public double max_y { get; set; }
255 
257  public int width { get; set; }
258 
260  public int height { get; set; }
261 
263  public string bg_color { get; set; }
264 
447  public IDictionary<string, IList<string>> style_options { get; set; } = new Dictionary<string, IList<string>>();
448 
475  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
476 
480 
716  IList<string> x_column_names,
717  IList<string> y_column_names,
718  double min_x,
719  double max_x,
720  double min_y,
721  double max_y,
722  int width,
723  int height,
724  string bg_color,
725  IDictionary<string, IList<string>> style_options,
726  IDictionary<string, string> options = null)
727  {
728  this.table_name = table_name ?? "";
729  this.x_column_names = x_column_names ?? new List<string>();
730  this.y_column_names = y_column_names ?? new List<string>();
731  this.min_x = min_x;
732  this.max_x = max_x;
733  this.min_y = min_y;
734  this.max_y = max_y;
735  this.width = width;
736  this.height = height;
737  this.bg_color = bg_color ?? "";
738  this.style_options = style_options ?? new Dictionary<string, IList<string>>();
739  this.options = options ?? new Dictionary<string, string>();
740  } // end constructor
741 } // end class VisualizeImageChartRequest
742 
747 {
752  public struct AxesInfo
753  {
756  public const string SORTED_X_VALUES = "sorted_x_values";
757 
760  public const string LOCATION_X = "location_x";
761 
764  public const string SORTED_Y_VALUES = "sorted_y_values";
765 
768  public const string LOCATION_Y = "location_y";
769  } // end struct AxesInfo
770 
774  public double min_x { get; set; }
775 
779  public double max_x { get; set; }
780 
784  public double min_y { get; set; }
785 
789  public double max_y { get; set; }
790 
793  public int width { get; set; }
794 
797  public int height { get; set; }
798 
801  public string bg_color { get; set; }
802 
804  public byte[] image_data { get; set; }
805 
832  public IDictionary<string, IList<string>> axes_info { get; set; } = new Dictionary<string, IList<string>>();
833 
835  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
836 } // end class VisualizeImageChartResponse
const string Y_ORDER_BY
An expression or aggregate expression by which non-numeric y column values are sorted,...
double min_y
Lower bound for the y column values as provided in min_y or calculated for non-numeric columns when p...
const string POINTCOLOR
The color of points in the plot represented as a hexadecimal number.
const string CB_POINTSHAPES
Point shape class break information consisting of three entries: class-break attribute,...
double max_y
Upper bound for the y column values.
const string CB_DELIMITER
A character or string which separates per-class values in a class-break style option string.
IList< string > y_column_names
Names of the columns containing the data mapped to the y axis of a chart.
const string NONE
Do not apply any additional encoding to the output image.
int height
Height of the generated image in pixels.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string bg_color
Background color of the generated image.
const string SCALE_TYPE_Y
Type of y axis scale.
const string NONE
No scale is applied to the y axis.
A set of results returned by Kinetica.visualizeImageChart.
const string JITTER_Y
Amplitude of vertical jitter applied to non-numeric y column values.
string table_name
Name of the table containing the data to be drawn as a chart, in [schema_name.
int width
Width of the image as provided in width.
const string PLOT_ALL
If this options is set to TRUE, all non-numeric column values are plotted ignoring min_x,...
IList< string > x_column_names
Names of the columns containing the data mapped to the x axis of a chart.
const string X_ORDER_BY
An expression or aggregate expression by which non-numeric x column values are sorted,...
IDictionary< string, IList< string > > style_options
Rendering style options for a chart.
double min_y
Lower bound for the y column values.
const string POINTSHAPE
The shape of points in the plot.
IDictionary< string, string > options
Optional parameters.
double max_x
Upper bound for the x column values as provided in max_x or calculated for non-numeric columns when p...
double min_x
Lower bound for the x column values.
const string IMAGE_ENCODING
Encoding to be applied to the output image.
const string SCALE_TYPE_X
Type of x axis scale.
IDictionary< string, string > info
Additional information.
const string SORTED_X_VALUES
Sorted non-numeric x column value list for drawing x axis label.
double max_y
Upper bound for the y column values as provided in max_y or calculated for non-numeric columns when p...
byte [] image_data
The generated image data.
const string SORTED_Y_VALUES
Sorted non-numeric y column value list for drawing y axis label.
VisualizeImageChartRequest()
Constructs a VisualizeImageChartRequest object with default parameters.
const string BASE64
Apply base64 encoding to the output image.
A set of string constants for the parameter axes_info.
const string LOCATION_X
X axis label positions of sorted_x_values in pixel coordinates.
A set of parameters for Kinetica.visualizeImageChart.
const string CB_POINTSIZES
Point size class break information consisting of three entries: class-break attribute,...
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.
double min_x
Lower bound for the x column values as provided in min_x or calculated for non-numeric columns when p...
IDictionary< string, IList< string > > axes_info
Information returned for drawing labels for the axes associated with non-numeric columns.
const string LOCATION_Y
Y axis label positions of sorted_y_values in pixel coordinates.
const string MIN_MAX_SCALED
If this options is set to FALSE, this endpoint expects request's min/max values are not yet scaled.
const string CB_POINTCOLORS
Point color class break information consisting of three entries: class-break attribute,...
A set of string constants for the parameter options.
const string LOG
A base-10 log scale is applied to the y axis.
A set of string constants for the parameter style_options.
int width
Width of the generated image in pixels.
double max_x
Upper bound for the x column values.
const string JITTER_X
Amplitude of horizontal jitter applied to non-numeric x column values.
int height
Height of the image as provided in height.
string bg_color
Background color of the image as provided in bg_color.
const string POINTSIZE
The size of points in the plot represented as number of pixels.