Kinetica C# API  Version 6.1.0.0
Public Attributes | List of all members
kinetica.VisualizeImageChartRequest.StyleOptions Struct Reference

Rendering style options for a chart. More...

Public Attributes

const string POINTCOLOR = "pointcolor"
 The color of points in the plot represented as a hexadecimal number. More...
 
const string POINTSIZE = "pointsize"
 The size of points in the plot represented as number of pixels. More...
 
const string POINTSHAPE = "pointshape"
 The shape of points in the plot. More...
 
const string NONE = "none"
 
const string CIRCLE = "circle"
 
const string SQUARE = "square"
 
const string DIAMOND = "diamond"
 
const string HOLLOWCIRCLE = "hollowcircle"
 
const string HOLLOWSQUARE = "hollowsquare"
 
const string HOLLOWDIAMOND = "hollowdiamond"
 
const string CB_POINTCOLORS = "cb_pointcolors"
 Point color class break information consisting of three entries: class-break attribute, class-break values/ranges, and point color values. More...
 
const string CB_POINTSIZES = "cb_pointsizes"
 Point size class break information consisting of three entries: class-break attribute, class-break values/ranges, and point size values. More...
 
const string CB_POINTSHAPES = "cb_pointshapes"
 Point shape class break information consisting of three entries: class-break attribute, class-break values/ranges, and point shape names. More...
 
const string CB_DELIMITER = "cb_delimiter"
 A character or string which separates per-class values in a class-break style option string. More...
 
const string X_ORDER_BY = "x_order_by"
 An expression or aggregate expression by which non-numeric x column values are sorted, e.g. More...
 
const string Y_ORDER_BY = "y_order_by"
 An expression or aggregate expression by which non-numeric y column values are sorted, e.g. More...
 
const string JITTER_X = "jitter_x"
 Amplitude of horizontal jitter applied to non-numaric x column values. More...
 
const string JITTER_Y = "jitter_y"
 Amplitude of vertical jitter applied to non-numaric y column values. More...
 
const string PLOT_ALL = "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. More...
 

Detailed Description

Rendering style options for a chart.

  • POINTCOLOR: The color of points in the plot represented as a hexadecimal number.
  • POINTSIZE: The size of points in the plot represented as number of pixels.
  • 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.
  • 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".
  • JITTER_X: Amplitude of horizontal jitter applied to non-numaric x column values.
  • JITTER_Y: Amplitude of vertical jitter applied to non-numaric y column values.
  • 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.


A set of string constants for the parameter style_options.

Definition at line 156 of file VisualizeImageChart.cs.

Member Data Documentation

◆ CB_DELIMITER

const string kinetica.VisualizeImageChartRequest.StyleOptions.CB_DELIMITER = "cb_delimiter"

A character or string which separates per-class values in a class-break style option string.

Definition at line 240 of file VisualizeImageChart.cs.

◆ CB_POINTCOLORS

const string kinetica.VisualizeImageChartRequest.StyleOptions.CB_POINTCOLORS = "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"}.

Definition at line 218 of file VisualizeImageChart.cs.

◆ CB_POINTSHAPES

const string kinetica.VisualizeImageChartRequest.StyleOptions.CB_POINTSHAPES = "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"}.

Definition at line 236 of file VisualizeImageChart.cs.

◆ CB_POINTSIZES

const string kinetica.VisualizeImageChartRequest.StyleOptions.CB_POINTSIZES = "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"}.

Definition at line 227 of file VisualizeImageChart.cs.

◆ CIRCLE

const string kinetica.VisualizeImageChartRequest.StyleOptions.CIRCLE = "circle"

Definition at line 203 of file VisualizeImageChart.cs.

◆ DIAMOND

const string kinetica.VisualizeImageChartRequest.StyleOptions.DIAMOND = "diamond"

Definition at line 205 of file VisualizeImageChart.cs.

◆ HOLLOWCIRCLE

const string kinetica.VisualizeImageChartRequest.StyleOptions.HOLLOWCIRCLE = "hollowcircle"

Definition at line 206 of file VisualizeImageChart.cs.

◆ HOLLOWDIAMOND

const string kinetica.VisualizeImageChartRequest.StyleOptions.HOLLOWDIAMOND = "hollowdiamond"

Definition at line 208 of file VisualizeImageChart.cs.

◆ HOLLOWSQUARE

const string kinetica.VisualizeImageChartRequest.StyleOptions.HOLLOWSQUARE = "hollowsquare"

Definition at line 207 of file VisualizeImageChart.cs.

◆ JITTER_X

const string kinetica.VisualizeImageChartRequest.StyleOptions.JITTER_X = "jitter_x"

Amplitude of horizontal jitter applied to non-numaric x column values.

Definition at line 254 of file VisualizeImageChart.cs.

◆ JITTER_Y

const string kinetica.VisualizeImageChartRequest.StyleOptions.JITTER_Y = "jitter_y"

Amplitude of vertical jitter applied to non-numaric y column values.

Definition at line 258 of file VisualizeImageChart.cs.

◆ NONE

const string kinetica.VisualizeImageChartRequest.StyleOptions.NONE = "none"

Definition at line 202 of file VisualizeImageChart.cs.

◆ PLOT_ALL

const string kinetica.VisualizeImageChartRequest.StyleOptions.PLOT_ALL = "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.

Definition at line 263 of file VisualizeImageChart.cs.

◆ POINTCOLOR

const string kinetica.VisualizeImageChartRequest.StyleOptions.POINTCOLOR = "pointcolor"

The color of points in the plot represented as a hexadecimal number.

Definition at line 161 of file VisualizeImageChart.cs.

◆ POINTSHAPE

const string kinetica.VisualizeImageChartRequest.StyleOptions.POINTSHAPE = "pointshape"

The shape of points in the plot.

Supported values:

The default value is SQUARE.

Definition at line 201 of file VisualizeImageChart.cs.

◆ POINTSIZE

const string kinetica.VisualizeImageChartRequest.StyleOptions.POINTSIZE = "pointsize"

The size of points in the plot represented as number of pixels.

Definition at line 165 of file VisualizeImageChart.cs.

◆ SQUARE

const string kinetica.VisualizeImageChartRequest.StyleOptions.SQUARE = "square"

Definition at line 204 of file VisualizeImageChart.cs.

◆ X_ORDER_BY

const string kinetica.VisualizeImageChartRequest.StyleOptions.X_ORDER_BY = "x_order_by"

An expression or aggregate expression by which non-numeric x column values are sorted, e.g.

"avg(price) descending".

Definition at line 245 of file VisualizeImageChart.cs.

◆ Y_ORDER_BY

const string kinetica.VisualizeImageChartRequest.StyleOptions.Y_ORDER_BY = "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".

Definition at line 250 of file VisualizeImageChart.cs.

The documentation for this struct was generated from the following file: