Skip to main content

◆ insertSymbol() [1/2]

InsertSymbolResponse kinetica.Kinetica.insertSymbol (InsertSymbolRequestrequest_)
inline

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.

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

Definition at line 52899 of file KineticaFunctions.cs.

◆ insertSymbol() [2/2]

InsertSymbolResponse kinetica.Kinetica.insertSymbol (stringsymbol_id,
stringsymbol_format,
byte[]symbol_data,
IDictionary< string, string >options = null )
inline

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.

Parameters
symbol_idThe id of the symbol being added. This is the same id that should be in the ‘SYMBOLCODE’ column for objects using this symbol.
symbol_formatSpecifies the symbol format. Must be either ‘svg’ or ‘svg_path’. Supported values:
symbol_dataThe 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’.
optionsOptional 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.
Returns
Response object containing the result of the operation.

Definition at line 52982 of file KineticaFunctions.cs.

◆ InsertSymbolAsync() [1/2]

async System.Threading.Tasks.Task< InsertSymbolResponse > kinetica.Kinetica.InsertSymbolAsync (InsertSymbolRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
inline

Adds a symbol or icon (i.e.

an image) to represent data points when data is rendered visually. (async)

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.

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 52924 of file KineticaFunctions.cs.

◆ InsertSymbolAsync() [2/2]

async System.Threading.Tasks.Task< InsertSymbolResponse > kinetica.Kinetica.InsertSymbolAsync (stringsymbol_id,
stringsymbol_format,
byte[]symbol_data,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
inline

Adds a symbol or icon (i.e.

an image) to represent data points when data is rendered visually. (async)

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.

Parameters
symbol_idThe id of the symbol being added. This is the same id that should be in the ‘SYMBOLCODE’ column for objects using this symbol.
symbol_formatSpecifies the symbol format. Must be either ‘svg’ or ‘svg_path’. Supported values:
symbol_dataThe 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’.
optionsOptional 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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 53043 of file KineticaFunctions.cs.