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.
Input Parameter Description
string
The id of the symbol being added. This is the same id that should be in the ‘SYMBOLCODE’ column for objects using this symbol.
string
Specifies the symbol format. Must be either ‘svg’ or ‘svg_path’.The supported values are:
svg
svg_path
bytes
The actual symbol data. If input parameter symbol_format is ‘svg’ then this should be the raw bytes representing an svg file. If input parameter 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’.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
If input parameter symbol_format is ‘svg’ this is ignored. If input parameter 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.
Output Parameter Description
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘insert_symbol_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /insert/symbol endpoint:
Show data_str
string
Value of input parameter symbol_id.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.