/insert/symbol

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/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 or /visualize/image) if the 'dosymbology' parameter is 'true' then GPUdb uses the value of the 'SYMBOLCODE' column to pick the symbol displayed for each point.

Input Parameter Description

Name	Type	Description
symbol_id	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
symbol_format	string	Specifies the symbol format. Must be either 'svg' or 'svg_path'. The allowed values are: svg svg_path
symbol_data	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'
options	map of strings	Optional parameters. Default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description color 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 GPUdb 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:

Name	Type	Description
status	String	'OK' or 'ERROR'
message	String	Empty if success or an error message
data_type	String	'insert_symbol_request' or 'none' in case of an error
data	String	Empty string
data_str	JSON or String	This embedded JSON represents the result of the /insert/symbol endpoint: Name Type Description symbol_id string Value of input parameter symbol_id. Empty string in case of an error.