insert_symbol
- insert_symbol(
symbol_id: string,
symbol_format: string,
symbol_data: string,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<InsertSymbolResponse>Parameters
- 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’.
- symbol_data: string
The actual symbol data. If
symbol_formatis ‘svg’ then this should be the raw bytes representing an svg file. Ifsymbol_formatis 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’. Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<InsertSymbolResponse>
Promise<Types.InsertSymbolResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:11752
- symbol_id: string
insert_symbol_request
- insert_symbol_request(
request: InsertSymbolRequest,
callback?: GPUdbCallback,
): Promise<InsertSymbolResponse>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: InsertSymbolRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<InsertSymbolResponse>
Promise<Types.InsertSymbolResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:11717
- request: InsertSymbolRequest
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.