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"
	No scale is applied to the y axis. More...
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	SCALE_TYPE_X = "scale_type_x"
	Type of x axis scale. More...
const string	LOG = "log"
	A base-10 log scale is applied to the y axis. More...
const string	SCALE_TYPE_Y = "scale_type_y"
	Type of y axis scale. More...
const string	MIN_MAX_SCALED = "min_max_scaled"
	If this options is set to "false", this endpoint expects request's min/max values are not yet scaled. More...
const string	JITTER_X = "jitter_x"
	Amplitude of horizontal jitter applied to non-numeric x column values. More...
const string	JITTER_Y = "jitter_y"
	Amplitude of vertical jitter applied to non-numeric 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. 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:
  • NONE
  • CIRCLE
  • SQUARE
  • DIAMOND
  • HOLLOWCIRCLE
  • HOLLOWSQUARE
  • HOLLOWDIAMOND
  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'.

A set of string constants for the parameter style_options.

Definition at line 214 of file VisualizeImageChart.cs.

Member Data Documentation

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.

The default value is ';'.

Definition at line 301 of file VisualizeImageChart.cs.

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 278 of file VisualizeImageChart.cs.

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 296 of file VisualizeImageChart.cs.

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 287 of file VisualizeImageChart.cs.

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

Definition at line 263 of file VisualizeImageChart.cs.

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

Definition at line 265 of file VisualizeImageChart.cs.

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

Definition at line 266 of file VisualizeImageChart.cs.

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

Definition at line 268 of file VisualizeImageChart.cs.

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

Definition at line 267 of file VisualizeImageChart.cs.

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

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

The default value is '0.0'.

Definition at line 369 of file VisualizeImageChart.cs.

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

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

The default value is '0.0'.

Definition at line 373 of file VisualizeImageChart.cs.

const string kinetica.VisualizeImageChartRequest.StyleOptions.LOG = "log"

A base-10 log scale is applied to the y axis.

Definition at line 335 of file VisualizeImageChart.cs.

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

Definition at line 365 of file VisualizeImageChart.cs.

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

No scale is applied to the y axis.

Definition at line 262 of file VisualizeImageChart.cs.

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.

The default value is 'false'.

Definition at line 378 of file VisualizeImageChart.cs.

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

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

The default value is '0000FF'.

Definition at line 219 of file VisualizeImageChart.cs.

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

The shape of points in the plot.

Supported values:

• NONE
• CIRCLE
• SQUARE
• DIAMOND
• HOLLOWCIRCLE
• HOLLOWSQUARE
• HOLLOWDIAMOND

The default value is SQUARE.

Definition at line 259 of file VisualizeImageChart.cs.

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

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

The default value is '3'.

Definition at line 223 of file VisualizeImageChart.cs.

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

Definition at line 331 of file VisualizeImageChart.cs.

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

Definition at line 355 of file VisualizeImageChart.cs.

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

Definition at line 264 of file VisualizeImageChart.cs.

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 306 of file VisualizeImageChart.cs.

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 311 of file VisualizeImageChart.cs.

---

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

• Kinetica/Protocol/VisualizeImageChart.cs