GPUdb C++ API  Version 5.2.0.0
gpudb::InsertSymbolResponse Struct Reference

A set of output parameters for insertSymbol(const InsertSymbolRequest&) const. More...

#include <gpudb/protocol/insert_symbol.h>

Public Member Functions

 InsertSymbolResponse ()
 Constructs an InsertSymbolResponse object with default parameter values. More...
 

Public Attributes

std::string symbolId
 

Detailed Description

A set of output parameters for insertSymbol(const InsertSymbolRequest&) const.

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 visualizeImage(const VisualizeImageRequest&) const) if the 'dosymbology' parameter is 'true' then GPUdb uses the value of the 'SYMBOLCODE' column to pick the symbol displayed for each point.

Definition at line 158 of file insert_symbol.h.

Constructor & Destructor Documentation

gpudb::InsertSymbolResponse::InsertSymbolResponse ( )
inline

Constructs an InsertSymbolResponse object with default parameter values.

Definition at line 165 of file insert_symbol.h.

Member Data Documentation

std::string gpudb::InsertSymbolResponse::symbolId

Definition at line 170 of file insert_symbol.h.


The documentation for this struct was generated from the following file: