> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.InsertSymbolRequest > kinetica.InsertSymbolRequest — Kinetica C# API

A set of parameters for Kinetica.insertSymbol. More...

Inheritance diagram for kinetica.InsertSymbolRequest:
Collaboration diagram for kinetica.InsertSymbolRequest:

Classes
struct   Options
  A set of string constants for the parameter InsertSymbolRequest.options. More...
 
struct   SymbolFormat
  A set of string constants for the parameter InsertSymbolRequest.symbol\_format. More...
 

Public Member Functions
  InsertSymbolRequest ()
  Constructs an InsertSymbolRequest object with default parameters.
 
  InsertSymbolRequest (string symbol\_id, string symbol\_format, byte\[] symbol\_data, IDictionary\< string, string > options=null)
  Constructs an InsertSymbolRequest object with the specified parameters.
 
  InsertSymbolRequest ()
  Constructs an InsertSymbolRequest object with default parameters.
 
  InsertSymbolRequest (string symbol\_id, string symbol\_format, byte\[] symbol\_data, IDictionary\< string, string > options=null)
  Constructs an InsertSymbolRequest 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  symbol\_id \[get, set]
  The id of the symbol being added.
 
string  symbol\_format \[get, set]
  Specifies the symbol format.
 
byte\[]  symbol\_data \[get, set]
  The actual symbol data.
 
IDictionary\< string, string >  options = new Dictionary\() \[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.insertSymbol.

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 24 of file InsertSymbol.cs.

Constructor & Destructor Documentation

◆ InsertSymbolRequest() \[1/4]

kinetica.InsertSymbolRequest.InsertSymbolRequest ( )
inline

Constructs an InsertSymbolRequest object with default parameters.

Definition at line 105 of file InsertSymbol.cs.

◆ InsertSymbolRequest() \[2/4]

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'. Supported values:
symbol\_data The actual symbol data. If symbol\_format is 'svg' then this should be the raw bytes representing an svg file. If symbol\_format 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 symbol\_format is 'svg' this is ignored. If symbol\_format 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.
The default value is an empty Dictionary.

Definition at line 146 of file InsertSymbol.cs.

◆ InsertSymbolRequest() \[3/4]

kinetica.InsertSymbolRequest.InsertSymbolRequest ( )
inline

Constructs an InsertSymbolRequest object with default parameters.

Definition at line 105 of file InsertSymbol.cs.

◆ InsertSymbolRequest() \[4/4]

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'. Supported values:
symbol\_data The actual symbol data. If symbol\_format is 'svg' then this should be the raw bytes representing an svg file. If symbol\_format 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 symbol\_format is 'svg' this is ignored. If symbol\_format 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.
The default value is an empty Dictionary.

Definition at line 146 of file InsertSymbol.cs.

Property Documentation

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 101 of file InsertSymbol.cs.

◆ symbol\_data

byte \[] kinetica.InsertSymbolRequest.symbol\_data
getset

The actual symbol data.

If InsertSymbolRequest.symbol\_format is 'svg' then this should be the raw bytes representing an svg file. If InsertSymbolRequest.symbol\_format 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 84 of file InsertSymbol.cs.

◆ symbol\_format

string kinetica.InsertSymbolRequest.symbol\_format
getset

Specifies the symbol format.

Must be either 'svg' or 'svg\_path'. Supported values:

Definition at line 75 of file InsertSymbol.cs.

◆ symbol\_id

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 59 of file InsertSymbol.cs.

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