Kinetica   C#   API  Version 7.2.3.0
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  {
27  public struct StyleOptions
28  {
32  public const string POINTCOLOR = "pointcolor";
33 
37  public const string POINTSIZE = "pointsize";
38 
75  public const string POINTSHAPE = "pointshape";
76 
78  public const string NONE = "none";
79 
80  public const string CIRCLE = "circle";
81  public const string SQUARE = "square";
82  public const string DIAMOND = "diamond";
83  public const string HOLLOWCIRCLE = "hollowcircle";
84  public const string HOLLOWSQUARE = "hollowsquare";
85  public const string HOLLOWDIAMOND = "hollowdiamond";
86 
96  public const string CB_POINTCOLORS = "cb_pointcolors";
97 
106  public const string CB_POINTSIZES = "cb_pointsizes";
107 
116  public const string CB_POINTSHAPES = "cb_pointshapes";
117 
121  public const string CB_DELIMITER = "cb_delimiter";
122 
126  public const string X_ORDER_BY = "x_order_by";
127 
131  public const string Y_ORDER_BY = "y_order_by";
132 
149  public const string SCALE_TYPE_X = "scale_type_x";
150 
153  public const string LOG = "log";
154 
171  public const string SCALE_TYPE_Y = "scale_type_y";
172 
181  public const string MIN_MAX_SCALED = "min_max_scaled";
182 
186  public const string JITTER_X = "jitter_x";
187 
191  public const string JITTER_Y = "jitter_y";
192 
197  public const string PLOT_ALL = "plot_all";
198  } // end struct StyleOptions
199 
203  public struct Options
204  {
221  public const string IMAGE_ENCODING = "image_encoding";
222 
224  public const string BASE64 = "base64";
225 
228  public const string NONE = "none";
229  } // end struct Options
230 
235  public string table_name { get; set; }
236 
239  public IList<string> x_column_names { get; set; } = new List<string>();
240 
243  public IList<string> y_column_names { get; set; } = new List<string>();
244 
248  public double min_x { get; set; }
249 
253  public double max_x { get; set; }
254 
258  public double min_y { get; set; }
259 
263  public double max_y { get; set; }
264 
266  public int width { get; set; }
267 
269  public int height { get; set; }
270 
272  public string bg_color { get; set; }
273 
471  public IDictionary<string, IList<string>> style_options { get; set; } = new Dictionary<string, IList<string>>();
472 
500  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
501 
505 
759  IList<string> x_column_names,
760  IList<string> y_column_names,
761  double min_x,
762  double max_x,
763  double min_y,
764  double max_y,
765  int width,
766  int height,
767  string bg_color,
768  IDictionary<string, IList<string>> style_options,
769  IDictionary<string, string> options = null)
770  {
771  this.table_name = table_name ?? "";
772  this.x_column_names = x_column_names ?? new List<string>();
773  this.y_column_names = y_column_names ?? new List<string>();
774  this.min_x = min_x;
775  this.max_x = max_x;
776  this.min_y = min_y;
777  this.max_y = max_y;
778  this.width = width;
779  this.height = height;
780  this.bg_color = bg_color ?? "";
781  this.style_options = style_options ?? new Dictionary<string, IList<string>>();
782  this.options = options ?? new Dictionary<string, string>();
783  } // end constructor
784  } // end class VisualizeImageChartRequest
785 
790  {
795  public struct AxesInfo
796  {
799  public const string SORTED_X_VALUES = "sorted_x_values";
800 
803  public const string LOCATION_X = "location_x";
804 
807  public const string SORTED_Y_VALUES = "sorted_y_values";
808 
811  public const string LOCATION_Y = "location_y";
812  } // end struct AxesInfo
813 
817  public double min_x { get; set; }
818 
822  public double max_x { get; set; }
823 
827  public double min_y { get; set; }
828 
832  public double max_y { get; set; }
833 
836  public int width { get; set; }
837 
840  public int height { get; set; }
841 
845  public string bg_color { get; set; }
846 
848  public byte[] image_data { get; set; }
849 
880  public IDictionary<string, IList<string>> axes_info { get; set; } = new Dictionary<string, IList<string>>();
881 
883  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
884  } // end class VisualizeImageChartResponse
885 } // end namespace kinetica
const string LOG
A base-10 log scale is applied to the y axis.
A set of string constants for the parameter options.
const string MIN_MAX_SCALED
If this options is set to "false", this endpoint expects request's min/max values are not yet scaled.
double min_y
Lower bound for the y column values as provided in min_y or calculated for non-numeric columns when p...
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,...
A set of results returned by Kinetica.visualizeImageChart.
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 height.
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 width.
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.
A set of string constants for the parameter axes_info.
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.
A set of string constants for the parameter style_options.
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,...
double max_x
Upper bound for the x column values as provided in max_x or calculated for non-numeric columns when p...
const string SCALE_TYPE_X
Type of x axis scale.
const string PLOT_ALL
If this options is set to "true", 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 min_x or calculated for non-numeric columns when p...
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 max_y or calculated for non-numeric columns when p...
const string Y_ORDER_BY
An expression or aggregate expression by which non-numeric y column values are sorted,...
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 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,...
const string X_ORDER_BY
An expression or aggregate expression by which non-numeric x column values are sorted,...
string bg_color
Background color of the image as provided in bg_color.