Skip to main content

A set of parameters for Kinetica.visualizeImageChart. More…

Inheritance diagram for kinetica.VisualizeImageChartRequest:
[legend]
Collaboration diagram for kinetica.VisualizeImageChartRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter VisualizeImageChartRequest.options. More…
 
struct  StyleOptions
 A set of string constants for the parameter VisualizeImageChartRequest.style_options. More…
 

​
Public Member Functions

 VisualizeImageChartRequest ()
 Constructs a VisualizeImageChartRequest object with default parameters.
 
 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.
 
 VisualizeImageChartRequest ()
 Constructs a VisualizeImageChartRequest object with default parameters.
 
 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.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

string table_name [get, set]
 Name of the table containing the data to be drawn as a chart, in [schema_name.
 
IList< string > x_column_names = new List<string>() [get, set]
 Names of the columns containing the data mapped to the x axis of a chart.
 
IList< string > y_column_names = new List<string>() [get, set]
 Names of the columns containing the data mapped to the y axis of a chart.
 
double min_x [get, set]
 Lower bound for the x column values.
 
double max_x [get, set]
 Upper bound for the x column values.
 
double min_y [get, set]
 Lower bound for the y column values.
 
double max_y [get, set]
 Upper bound for the y column values.
 
int width [get, set]
 Width of the generated image in pixels.
 
int height [get, set]
 Height of the generated image in pixels.
 
string bg_color [get, set]
 Background color of the generated image.
 
IDictionary< string, IList< string > > style_options = new Dictionary<string, IList<string>>() [get, set]
 Rendering style options for a chart.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.visualizeImageChart.

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

Definition at line 21 of file VisualizeImageChart.cs.

​
Constructor & Destructor Documentation

​
◆ VisualizeImageChartRequest() [1/4]

kinetica.VisualizeImageChartRequest.VisualizeImageChartRequest ()
 inline

Constructs a VisualizeImageChartRequest object with default parameters.

Definition at line 572 of file VisualizeImageChart.cs.

​
◆ VisualizeImageChartRequest() [2/4]

kinetica.VisualizeImageChartRequest.VisualizeImageChartRequest (stringtable_name,
IList< string >x_column_names,
IList< string >y_column_names,
doublemin_x,
doublemax_x,
doublemin_y,
doublemax_y,
intwidth,
intheight,
stringbg_color,
IDictionary< string, IList< string > >style_options,
IDictionary< string, string >options = null )
 inline

Constructs a VisualizeImageChartRequest object with the specified parameters.

Parameters
table_nameName of the table containing the data to be drawn as a chart, in [schema_name.]table_name format, using standard name resolution rules.
x_column_namesNames of the columns containing the data mapped to the x axis of a chart.
y_column_namesNames of the columns containing the data mapped to the y axis of a chart.
min_xLower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
max_xUpper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
min_yLower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
max_yUpper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
widthWidth of the generated image in pixels.
heightHeight of the generated image in pixels.
bg_colorBackground color of the generated image.
style_optionsRendering style options for a chart.
  • POINTCOLOR: The color of points in the plot represented as a hexadecimal number. The default value is ‘0000FF’.
  • POINTSIZE: The size of points in the plot represented as number of pixels. The default value is ‘3’.
  • POINTSHAPE: The shape of points in the plot. Supported values:The default value is SQUARE.
  • 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”.
  • 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”.
  • 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”.
  • CB_DELIMITER: A character or string which separates per-class values in a class-break style option string. The default value is ’;’.
  • X_ORDER_BY: An expression or aggregate expression by which non-numeric x column values are sorted, e.g. “avg(price) descending”.
  • 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”.
  • SCALE_TYPE_X: Type of x axis scale. Supported values:
    • NONE: No scale is applied to the x axis.
    • LOG: A base-10 log scale is applied to the x axis.
    The default value is NONE.
  • SCALE_TYPE_Y: Type of y axis scale. Supported values:
    • NONE: No scale is applied to the y axis.
    • LOG: A base-10 log scale is applied to the y axis.
    The default value is NONE.
  • 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’.
  • JITTER_X: Amplitude of horizontal jitter applied to non-numeric x column values. The default value is ‘0.0’.
  • JITTER_Y: Amplitude of vertical jitter applied to non-numeric y column values. The default value is ‘0.0’.
  • 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’.
optionsOptional parameters.
  • IMAGE_ENCODING: Encoding to be applied to the output image. When using JSON serialization it is recommended to specify this as BASE64. Supported values:
    • BASE64: Apply base64 encoding to the output image.
    • NONE: Do not apply any additional encoding to the output image.
    The default value is NONE.
The default value is an empty Dictionary.

Definition at line 849 of file VisualizeImageChart.cs.

​
◆ VisualizeImageChartRequest() [3/4]

kinetica.VisualizeImageChartRequest.VisualizeImageChartRequest ()
 inline

Constructs a VisualizeImageChartRequest object with default parameters.

Definition at line 572 of file VisualizeImageChart.cs.

​
◆ VisualizeImageChartRequest() [4/4]

kinetica.VisualizeImageChartRequest.VisualizeImageChartRequest (stringtable_name,
IList< string >x_column_names,
IList< string >y_column_names,
doublemin_x,
doublemax_x,
doublemin_y,
doublemax_y,
intwidth,
intheight,
stringbg_color,
IDictionary< string, IList< string > >style_options,
IDictionary< string, string >options = null )
 inline

Constructs a VisualizeImageChartRequest object with the specified parameters.

Parameters
table_nameName of the table containing the data to be drawn as a chart, in [schema_name.]table_name format, using standard name resolution rules.
x_column_namesNames of the columns containing the data mapped to the x axis of a chart.
y_column_namesNames of the columns containing the data mapped to the y axis of a chart.
min_xLower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
max_xUpper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
min_yLower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
max_yUpper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
widthWidth of the generated image in pixels.
heightHeight of the generated image in pixels.
bg_colorBackground color of the generated image.
style_optionsRendering style options for a chart.
  • POINTCOLOR: The color of points in the plot represented as a hexadecimal number. The default value is ‘0000FF’.
  • POINTSIZE: The size of points in the plot represented as number of pixels. The default value is ‘3’.
  • POINTSHAPE: The shape of points in the plot. Supported values:The default value is SQUARE.
  • 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”.
  • 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”.
  • 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”.
  • CB_DELIMITER: A character or string which separates per-class values in a class-break style option string. The default value is ’;’.
  • X_ORDER_BY: An expression or aggregate expression by which non-numeric x column values are sorted, e.g. “avg(price) descending”.
  • 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”.
  • SCALE_TYPE_X: Type of x axis scale. Supported values:
    • NONE: No scale is applied to the x axis.
    • LOG: A base-10 log scale is applied to the x axis.
    The default value is NONE.
  • SCALE_TYPE_Y: Type of y axis scale. Supported values:
    • NONE: No scale is applied to the y axis.
    • LOG: A base-10 log scale is applied to the y axis.
    The default value is NONE.
  • 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’.
  • JITTER_X: Amplitude of horizontal jitter applied to non-numeric x column values. The default value is ‘0.0’.
  • JITTER_Y: Amplitude of vertical jitter applied to non-numeric y column values. The default value is ‘0.0’.
  • 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’.
optionsOptional parameters.
  • IMAGE_ENCODING: Encoding to be applied to the output image. When using JSON serialization it is recommended to specify this as BASE64. Supported values:
    • BASE64: Apply base64 encoding to the output image.
    • NONE: Do not apply any additional encoding to the output image.
    The default value is NONE.
The default value is an empty Dictionary.

Definition at line 849 of file VisualizeImageChart.cs.

​
Property Documentation

​
◆ bg_color

string kinetica.VisualizeImageChartRequest.bg_color
 getset

Background color of the generated image.

Definition at line 315 of file VisualizeImageChart.cs.

​
◆ height

int kinetica.VisualizeImageChartRequest.height
 getset

Height of the generated image in pixels.

Definition at line 312 of file VisualizeImageChart.cs.

​
◆ max_x

double kinetica.VisualizeImageChartRequest.max_x
 getset

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.

Definition at line 296 of file VisualizeImageChart.cs.

​
◆ max_y

double kinetica.VisualizeImageChartRequest.max_y
 getset

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.

Definition at line 306 of file VisualizeImageChart.cs.

​
◆ min_x

double kinetica.VisualizeImageChartRequest.min_x
 getset

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.

Definition at line 291 of file VisualizeImageChart.cs.

​
◆ min_y

double kinetica.VisualizeImageChartRequest.min_y
 getset

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.

Definition at line 301 of file VisualizeImageChart.cs.

​
◆ options

IDictionary< string, string > kinetica.VisualizeImageChartRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

  • IMAGE_ENCODING: Encoding to be applied to the output image. When using JSON serialization it is recommended to specify this as BASE64. Supported values:
    • BASE64: Apply base64 encoding to the output image.
    • NONE: Do not apply any additional encoding to the output image.
    The default value is NONE.

The default value is an empty Dictionary.

Definition at line 568 of file VisualizeImageChart.cs.

​
◆ style_options

IDictionary< string, IList< string > > kinetica.VisualizeImageChartRequest.style_options = new Dictionary<string, IList<string>>()
 getset

Rendering style options for a chart.

  • POINTCOLOR: The color of points in the plot represented as a hexadecimal number. The default value is ‘0000FF’.
  • POINTSIZE: The size of points in the plot represented as number of pixels. The default value is ‘3’.
  • POINTSHAPE: The shape of points in the plot. Supported values:The default value is SQUARE.
  • 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”.
  • 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”.
  • 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”.
  • CB_DELIMITER: A character or string which separates per-class values in a class-break style option string. The default value is ’;’.
  • X_ORDER_BY: An expression or aggregate expression by which non-numeric x column values are sorted, e.g. “avg(price) descending”.
  • 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”.
  • SCALE_TYPE_X: Type of x axis scale. Supported values:
    • NONE: No scale is applied to the x axis.
    • LOG: A base-10 log scale is applied to the x axis.
    The default value is NONE.
  • SCALE_TYPE_Y: Type of y axis scale. Supported values:
    • NONE: No scale is applied to the y axis.
    • LOG: A base-10 log scale is applied to the y axis.
    The default value is NONE.
  • 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’.
  • JITTER_X: Amplitude of horizontal jitter applied to non-numeric x column values. The default value is ‘0.0’.
  • JITTER_Y: Amplitude of vertical jitter applied to non-numeric y column values. The default value is ‘0.0’.
  • 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’.

Definition at line 533 of file VisualizeImageChart.cs.

​
◆ table_name

string kinetica.VisualizeImageChartRequest.table_name
 getset

Name of the table containing the data to be drawn as a chart, in [schema_name.

]table_name format, using standard name resolution rules.

Definition at line 278 of file VisualizeImageChart.cs.

​
◆ width

int kinetica.VisualizeImageChartRequest.width
 getset

Width of the generated image in pixels.

Definition at line 309 of file VisualizeImageChart.cs.

​
◆ x_column_names

IList< string > kinetica.VisualizeImageChartRequest.x_column_names = new List<string>()
 getset

Names of the columns containing the data mapped to the x axis of a chart.

Definition at line 282 of file VisualizeImageChart.cs.

​
◆ y_column_names

IList< string > kinetica.VisualizeImageChartRequest.y_column_names = new List<string>()
 getset

Names of the columns containing the data mapped to the y axis of a chart.

Definition at line 286 of file VisualizeImageChart.cs.

The documentation for this class was generated from the following files: