Skip to main content
Source

​
pub async fn insert_symbol( &self, symbol_id: String, symbol_format: String, symbol_data: ByteBuf, ) -> Result<InsertSymbolResponse, KineticaError>

Add rendering symbol or icon to the database

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.

  • 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’.
  • 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’.
Source

​
pub async fn insert_symbol_with_opts( &self, symbol_id: String, symbol_format: String, symbol_data: ByteBuf, options: InsertSymbolRequestOptions, ) -> Result<InsertSymbolResponse, KineticaError>

Add rendering symbol or icon to the database

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.

  • 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’.
  • 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 - The optional parameters; any left unset take the server’s defaults.

Sends a pre-built InsertSymbolRequest to the /insert/symbol endpoint.

Sends a pre-built InsertSymbolRequest to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.