> ## 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-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="insertSymbol(com.gpudb.protocol.InsertSymbolRequest)">
        <h3>insertSymbol</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/InsertSymbolResponse" title="class in com.gpudb.protocol">InsertSymbolResponse</a></span> <span className="element-name">insertSymbol</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/InsertSymbolRequest" title="class in com.gpudb.protocol">InsertSymbolRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">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.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/InsertSymbolRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/InsertSymbolResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="insertSymbol(java.lang.String,java.lang.String,java.nio.ByteBuffer,java.util.Map)">
        <h3>insertSymbol</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/InsertSymbolResponse" title="class in com.gpudb.protocol">InsertSymbolResponse</a></span> <span className="element-name">insertSymbol</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> symbolId, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> symbolFormat, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" className="external-link">ByteBuffer</a> symbolData, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">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.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>symbolId</code> - The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol.</div>

          <div className="dd">
            <code>symbolFormat</code> - Specifies the symbol format. Must be either 'svg' or 'svg\_path'. Supported values:

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/InsertSymbolRequest.SymbolFormat#SVG"><code>SVG</code></a> </li>
              <li><a href="/content/api/java/com/gpudb/protocol/InsertSymbolRequest.SymbolFormat#SVG_PATH"><code>SVG\_PATH</code></a> </li>
            </ul>
          </div>

          <div className="dd"><code>symbolData</code> - The actual symbol data. If <code>symbolFormat</code> is 'svg' then this should be the raw bytes representing an svg file. If <code>symbolFormat</code> 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'.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/InsertSymbolRequest.Options#COLOR"><code>COLOR</code></a>: If <code>symbolFormat</code> is 'svg' this is ignored. If <code>symbolFormat</code> 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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/InsertSymbolResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>