> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# insert_symbol

### insert\_symbol

<ul>
  <li>
    insert\_symbol(\
    &#x20;symbol\_id: string,\
    &#x20;symbol\_format: string,\
    &#x20;symbol\_data: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[InsertSymbolResponse](https://docs.kinetica.com/content/api/javascript/interfaces/InsertSymbolResponse.md)>

    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

    <ul>
      <li>
        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.
      </li>

      <li>
        symbol\_format: string

        Specifies the symbol format. Must be either 'svg' or 'svg\_path'.
      </li>

      <li>
        symbol\_data: string

        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'.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[InsertSymbolResponse](https://docs.kinetica.com/content/api/javascript/interfaces/InsertSymbolResponse.md)>

    Promise\<Types.InsertSymbolResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:12008](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L12008)</li>
    </ul>
  </li>
</ul>

### insert\_symbol\_request

<ul>
  <li>
    insert\_symbol\_request(\
    &#x20;request: [InsertSymbolRequest](https://docs.kinetica.com/content/api/javascript/interfaces/InsertSymbolRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[InsertSymbolResponse](https://docs.kinetica.com/content/api/javascript/interfaces/InsertSymbolResponse.md)>

    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

    <ul>
      <li>
        request: [InsertSymbolRequest](https://docs.kinetica.com/content/api/javascript/interfaces/InsertSymbolRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[InsertSymbolResponse](https://docs.kinetica.com/content/api/javascript/interfaces/InsertSymbolResponse.md)>

    Promise\<Types.InsertSymbolResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:11973](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L11973)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.