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

# gpudb::InsertSymbolRequest

> gpudb::InsertSymbolRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a33ff57e8504882376321fa9a5537fedf">GPUdb::insertSymbol</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/insert__symbol_8h_source">gpudb/protocol/insert\_symbol.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:ad6b360cf3e27a60104a2d5398b556976" id="r_ad6b360cf3e27a60104a2d5398b556976">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad6b360cf3e27a60104a2d5398b556976">InsertSymbolRequest</a> ()</td>
      </tr>

      <tr className="memdesc:ad6b360cf3e27a60104a2d5398b556976">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolRequest" title="A set of parameters for GPUdb::insertSymbol.">InsertSymbolRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:ad6b360cf3e27a60104a2d5398b556976">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a5055f60693339d00a0c5b14de8591537" id="r_a5055f60693339d00a0c5b14de8591537">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5055f60693339d00a0c5b14de8591537">InsertSymbolRequest</a> (const std::string \&symbolId\_, const std::string \&symbolFormat\_, const std::vector\< uint8\_t > \&symbolData\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a5055f60693339d00a0c5b14de8591537">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolRequest" title="A set of parameters for GPUdb::insertSymbol.">InsertSymbolRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a5055f60693339d00a0c5b14de8591537">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a49b1f396eca8d598a7306e85290da575" id="r_a49b1f396eca8d598a7306e85290da575">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a49b1f396eca8d598a7306e85290da575">symbolId</a></td>
      </tr>

      <tr className="memdesc:a49b1f396eca8d598a7306e85290da575">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The id of the symbol being added. <br /></td>
      </tr>

      <tr className="separator:a49b1f396eca8d598a7306e85290da575">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a047054e08879478d8a3b3fab03b9144a" id="r_a047054e08879478d8a3b3fab03b9144a">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a047054e08879478d8a3b3fab03b9144a">symbolFormat</a></td>
      </tr>

      <tr className="memdesc:a047054e08879478d8a3b3fab03b9144a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Specifies the symbol format. <br /></td>
      </tr>

      <tr className="separator:a047054e08879478d8a3b3fab03b9144a">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:afbe1c5a382c5e2824ade79949e69ac6d" id="r_afbe1c5a382c5e2824ade79949e69ac6d">
        <td className="memItemLeft" align="right" valign="top">std::vector\< uint8\_t > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#afbe1c5a382c5e2824ade79949e69ac6d">symbolData</a></td>
      </tr>

      <tr className="memdesc:afbe1c5a382c5e2824ade79949e69ac6d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The actual symbol data. <br /></td>
      </tr>

      <tr className="separator:afbe1c5a382c5e2824ade79949e69ac6d">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a7bb0db7cd7858a34c077e59cf2aa46bf" id="r_a7bb0db7cd7858a34c077e59cf2aa46bf">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7bb0db7cd7858a34c077e59cf2aa46bf">options</a></td>
      </tr>

      <tr className="memdesc:a7bb0db7cd7858a34c077e59cf2aa46bf">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:a7bb0db7cd7858a34c077e59cf2aa46bf">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a33ff57e8504882376321fa9a5537fedf">GPUdb::insertSymbol</a>. </p>
      <p>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 <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>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/insert__symbol_8h_source#l00027">27</a> of file <a className="el" href="/content/api/cpp/insert__symbol_8h_source">insert\_symbol.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ad6b360cf3e27a60104a2d5398b556976">◆ </a></span>InsertSymbolRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::InsertSymbolRequest::InsertSymbolRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolRequest" title="A set of parameters for GPUdb::insertSymbol.">InsertSymbolRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/insert__symbol_8h_source#l00032">32</a> of file <a className="el" href="/content/api/cpp/insert__symbol_8h_source">insert\_symbol.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::InsertSymbolRequest::InsertSymbolRequest </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>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1InsertSymbolRequest" title="A set of parameters for GPUdb::insertSymbol.">InsertSymbolRequest</a> object with the specified parameters. </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>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/insert__symbol_8h_source#l00077">77</a> of file <a className="el" href="/content/api/cpp/insert__symbol_8h_source">insert\_symbol.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a7bb0db7cd7858a34c077e59cf2aa46bf">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::InsertSymbolRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>

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

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/insert__symbol_8h_source#l00121">121</a> of file <a className="el" href="/content/api/cpp/insert__symbol_8h_source">insert\_symbol.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#afbe1c5a382c5e2824ade79949e69ac6d">◆ </a></span>symbolData</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<uint8\_t> gpudb::InsertSymbolRequest::symbolData</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The actual symbol data. </p>
        <p>If <a className="el" href="#a047054e08879478d8a3b3fab03b9144a">symbolFormat</a> is 'svg' then this should be the raw bytes representing an svg file. If <a className="el" href="#a047054e08879478d8a3b3fab03b9144a">symbolFormat</a> 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'. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/insert__symbol_8h_source#l00107">107</a> of file <a className="el" href="/content/api/cpp/insert__symbol_8h_source">insert\_symbol.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a047054e08879478d8a3b3fab03b9144a">◆ </a></span>symbolFormat</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::InsertSymbolRequest::symbolFormat</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Specifies the symbol format. </p>
        <p>Must be either 'svg' or 'svg\_path'. Supported values: </p>

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

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/insert__symbol_8h_source#l00099">99</a> of file <a className="el" href="/content/api/cpp/insert__symbol_8h_source">insert\_symbol.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a49b1f396eca8d598a7306e85290da575">◆ </a></span>symbolId</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::InsertSymbolRequest::symbolId</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The id of the symbol being added. </p>
        <p>This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/insert__symbol_8h_source#l00089">89</a> of file <a className="el" href="/content/api/cpp/insert__symbol_8h_source">insert\_symbol.h</a>.</p>
      </div>
    </div>

    <hr />

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

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/insert__symbol_8h_source">insert\_symbol.h</a></li>
    </ul>
  </div>
</div>