> ## 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.

# insertSymbol

<div className="kinetica-doxygen">
  <div id="a33ff57e8504882376321fa9a5537fedf" />

  <h2 className="memtitle"><span className="permalink"><a href="#a33ff57e8504882376321fa9a5537fedf">◆ </a></span>insertSymbol() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">InsertSymbolResponse</a> gpudb::GPUdb::insertSymbol </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolRequest">InsertSymbolRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually. </p>
      <p>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 <a href="/content/api/rest/wms_rest/" target="_top">WMS</a>) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a859126a4b037a7689ae7b7a2ac742129" />

  <h2 className="memtitle"><span className="permalink"><a href="#a859126a4b037a7689ae7b7a2ac742129">◆ </a></span>insertSymbol() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">InsertSymbolResponse</a> & gpudb::GPUdb::insertSymbol </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolRequest">InsertSymbolRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">InsertSymbolResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually. </p>
      <p>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 <a href="/content/api/rest/wms_rest/" target="_top">WMS</a>) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a15ce82e07d56b203892660f07d65c610" />

  <h2 className="memtitle"><span className="permalink"><a href="#a15ce82e07d56b203892660f07d65c610">◆ </a></span>insertSymbol() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">InsertSymbolResponse</a> gpudb::GPUdb::insertSymbol </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">symbolId</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">symbolFormat</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::vector\< uint8\_t > &</td>
          <td className="paramname"><span className="paramname"><span className="em">symbolData</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually. </p>
      <p>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 <a href="/content/api/rest/wms_rest/" target="_top">WMS</a>) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">symbolId</td>
              <td>The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">symbolFormat</td>

              <td>
                Specifies the symbol format. Must be either 'svg' or 'svg\_path'. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4b4767cc88e5802e9fb5c5e64ec4533c">insert\_symbol\_svg</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a120aa00c7ac2c865877b5481680c55b3">insert\_symbol\_svg\_path</a> </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">symbolData</td>
              <td>The actual symbol data. If <span className="em arg">symbolFormat</span> is 'svg' then this should be the raw bytes representing an svg file. If <span className="em arg">symbolFormat</span> 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'. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a04f5c6609cb43f0dc7d7371fcc5f8a97">insert\_symbol\_color</a>: If <span className="em arg">symbolFormat</span> is 'svg' this is ignored. If <span className="em arg">symbolFormat</span> 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. </li>
                </ul>

                The default value is an empty map.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="aad297dd0e66db2d92e3a213b989a0040" />

  <h2 className="memtitle"><span className="permalink"><a href="#aad297dd0e66db2d92e3a213b989a0040">◆ </a></span>insertSymbol() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">InsertSymbolResponse</a> & gpudb::GPUdb::insertSymbol </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">symbolId</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">symbolFormat</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::vector\< uint8\_t > &</td>
          <td className="paramname"><span className="paramname"><span className="em">symbolData</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">InsertSymbolResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually. </p>
      <p>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 <a href="/content/api/rest/wms_rest/" target="_top">WMS</a>) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.</p>

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">symbolId</td>
              <td>The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">symbolFormat</td>

              <td>
                Specifies the symbol format. Must be either 'svg' or 'svg\_path'. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4b4767cc88e5802e9fb5c5e64ec4533c">insert\_symbol\_svg</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a120aa00c7ac2c865877b5481680c55b3">insert\_symbol\_svg\_path</a> </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">symbolData</td>
              <td>The actual symbol data. If <span className="em arg">symbolFormat</span> is 'svg' then this should be the raw bytes representing an svg file. If <span className="em arg">symbolFormat</span> 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'. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a04f5c6609cb43f0dc7d7371fcc5f8a97">insert\_symbol\_color</a>: If <span className="em arg">symbolFormat</span> is 'svg' this is ignored. If <span className="em arg">symbolFormat</span> 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. </li>
                </ul>

                The default value is an empty map.
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>