kinetica.InsertSymbolRequest Class Reference

A set of parameters for /insert/symbol. More...

Inheritance diagram for kinetica.InsertSymbolRequest:

Collaboration diagram for kinetica.InsertSymbolRequest:

Classes
struct	Options
	Optional parameters. More...
struct	SymbolFormat
	Specifies the symbol format. More...

Public Member Functions
	InsertSymbolRequest ()
	Constructs an InsertSymbolRequest object with default parameters. More...
	InsertSymbolRequest (string symbol_id, string symbol_format, byte[] symbol_data, IDictionary< string, string > options=null)
	Constructs an InsertSymbolRequest object with the specified parameters. More...
Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...
	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...
object	Get (int fieldPos)
	Retrieve a specific property from this object More...
void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	symbol_id [get, set]
	The id of the symbol being added. More...
string	symbol_format [get, set]
	Specifies the symbol format. More...
byte[]	symbol_data [get, set]
	The actual symbol data. More...
IDictionary< string, string >	options [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

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. More...

Detailed Description

A set of parameters for /insert/symbol.

Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.

Definition at line 27 of file InsertSymbol.cs.

Constructor & Destructor Documentation

kinetica.InsertSymbolRequest.InsertSymbolRequest ( )

inline

Constructs an InsertSymbolRequest object with default parameters.

Definition at line 109 of file InsertSymbol.cs.

kinetica.InsertSymbolRequest.InsertSymbolRequest ( string  symbol_id, string  symbol_format, byte[]  symbol_data, IDictionary< string, string >  options = null  )

inline

Constructs an InsertSymbolRequest object with the specified parameters.

Parameters

symbol_id	The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol
symbol_format	Specifies the symbol format. Must be either 'svg' or 'svg_path'. Values: svg, svg_path.
symbol_data	The actual symbol data. If is 'svg' then this should be the raw bytes representing an svg file. If is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'
options	Optional parameters. color If is 'svg' this is ignored. If is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.

Definition at line 141 of file InsertSymbol.cs.

Property Documentation

IDictionary<string, string> kinetica.InsertSymbolRequest.options

getset

Optional parameters.

• color If is 'svg' this is ignored. If is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.

Definition at line 104 of file InsertSymbol.cs.

byte [] kinetica.InsertSymbolRequest.symbol_data

getset

The actual symbol data.

If is 'svg' then this should be the raw bytes representing an svg file. If is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'

Definition at line 88 of file InsertSymbol.cs.

string kinetica.InsertSymbolRequest.symbol_format

getset

Specifies the symbol format.

Must be either 'svg' or 'svg_path'. Values: svg, svg_path.

Definition at line 79 of file InsertSymbol.cs.

string kinetica.InsertSymbolRequest.symbol_id

getset

The id of the symbol being added.

This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol

Definition at line 74 of file InsertSymbol.cs.

---

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

• Kinetica/Protocol/InsertSymbol.cs