Skip to main content

​
◆ visualizeImageChart() [1/2]

VisualizeImageChartResponse kinetica.Kinetica.visualizeImageChart (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

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.

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.
Returns
Response object containing the result of the operation.

Definition at line 66692 of file KineticaFunctions.cs.

​
◆ visualizeImageChart() [2/2]

VisualizeImageChartResponse kinetica.Kinetica.visualizeImageChart (VisualizeImageChartRequestrequest_)
 inline

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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 66379 of file KineticaFunctions.cs.

​
◆ VisualizeImageChartAsync() [1/2]

async System.Threading.Tasks.Task< VisualizeImageChartResponse > kinetica.Kinetica.VisualizeImageChartAsync (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,
System.Threading.CancellationTokencancellationToken = default )
 inline

Scatter plot is the only plot type currently supported.

(async)

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.

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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 66999 of file KineticaFunctions.cs.

​
◆ VisualizeImageChartAsync() [2/2]

async System.Threading.Tasks.Task< VisualizeImageChartResponse > kinetica.Kinetica.VisualizeImageChartAsync (VisualizeImageChartRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Scatter plot is the only plot type currently supported.

(async)

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.

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 66401 of file KineticaFunctions.cs.