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

<div className="kinetica-pydoc">
  <div className="dl py method">
    <div className="dt sig sig-object py" id="gpudb.GPUdb.insert_symbol"> <span className="sig-name descname"><span className="pre">insert\_symbol</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">symbol\_id</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">symbol\_format</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">symbol\_data</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">options</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">{"{"}{"}"}</span></span></span><span className="sig-paren">)</span><a href="https://github.com/kineticadb/kinetica-api-python/blob/master/gpudb/gpudb.py#L35940"><span className="viewcode-link"><span className="pre">\[source]</span></span></a></div>

    <div className="dd">
      <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 className="reference external" href="/content/api/rest/wms_rest/">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><strong>Parameters</strong></p>

      <div className="blockquote">
        <div>
          <div className="dl">
            <div className="dt">symbol\_id (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The id of the symbol being added. This is the same id that should be in the ‘SYMBOLCODE’ column for objects using this symbol.</p>
            </div>

            <div className="dt">symbol\_format (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>Specifies the symbol format. Must be either ‘svg’ or ‘svg\_path’. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>svg</p>
                </li>

                <li>
                  <p>svg\_path</p>
                </li>
              </ul>
            </div>

            <div className="dt">symbol\_data (<span className="em">bytes</span>) –</div>

            <div className="dd">
              <p>The actual symbol data. If input parameter <span className="em">symbol\_format</span> is ‘svg’ then this should be the raw bytes representing an svg file. If input parameter <span className="em">symbol\_format</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’.</p>
            </div>

            <div className="dt">options (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Optional parameters. Allowed keys are:</p>

              <ul className="simple">
                <li>
                  <p><strong>color</strong> – If input parameter <span className="em">symbol\_format</span> is ‘svg’ this is ignored. If input parameter <span className="em">symbol\_format</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.</p>
                </li>
              </ul>

              <p>The default value is an empty dict ( {"{"}{"}"} ).</p>
            </div>
          </div>
        </div>
      </div>

      <p><strong>Returns</strong></p>

      <div className="blockquote">
        <div>
          <p>A dict with the following entries–</p>

          <div className="dl simple">
            <div className="dt">symbol\_id (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>Value of input parameter <span className="em">symbol\_id</span>.</p>
            </div>

            <div className="dt">info (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Additional information.</p>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>