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

# filterByAreaGeometry

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

  <h2 className="memtitle"><span className="permalink"><a href="#a2bc0ad61d786b878102a21366685f24e">◆ </a></span>filterByAreaGeometry() <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"><a className="el" href="/content/api/cs/classkinetica_1_1FilterByAreaGeometryResponse">FilterByAreaGeometryResponse</a> kinetica.Kinetica.filterByAreaGeometry </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1FilterByAreaGeometryRequest">FilterByAreaGeometryRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). </p>
      <p>The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name <a className="el" href="/content/api/cs/classkinetica_1_1FilterByAreaGeometryRequest#ae3593fed483156317e382ab499166982">view\_name</a> passed in as part of the input.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request 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">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L36713">36713</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="aa182cdc290af523e65816ed73c931990" />

  <h2 className="memtitle"><span className="permalink"><a href="#aa182cdc290af523e65816ed73c931990">◆ </a></span>filterByAreaGeometry() <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"><a className="el" href="/content/api/cs/classkinetica_1_1FilterByAreaGeometryResponse">FilterByAreaGeometryResponse</a> kinetica.Kinetica.filterByAreaGeometry </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">view\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">column\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IList\< double ></td>
                <td className="paramname"><span className="paramname"><span className="em">x\_vector</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IList\< double ></td>
                <td className="paramname"><span className="paramname"><span className="em">y\_vector</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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>Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). </p>
      <p>The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name <span className="em">view\_name</span> passed in as part of the input.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">table\_name</td>
              <td>Name of the table to filter, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. This may be the name of a table or a view (when chaining queries).</td>
            </tr>

            <tr>
              <td className="paramname">view\_name</td>
              <td>If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Must not be an already existing table or view. The default value is ''.</td>
            </tr>

            <tr>
              <td className="paramname">column\_name</td>
              <td>Name of the geospatial geometry column to be filtered.</td>
            </tr>

            <tr>
              <td className="paramname">x\_vector</td>
              <td>List of x coordinates of the vertices of the polygon representing the area to be filtered.</td>
            </tr>

            <tr>
              <td className="paramname">y\_vector</td>
              <td>List of y coordinates of the vertices of the polygon representing the area to be filtered.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a2ef0d670887ea9b7a33f549113c3e9b5">CREATE\_TEMP\_TABLE</a>: If <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a1c88f4fe15560198526fcc4386b4291a">TRUE</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <span className="em">view\_name</span> . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryResponse_1_1Info#ac91bcdf84850987dfa3dbf8030d3fef1">QUALIFIED\_VIEW\_NAME</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a1c88f4fe15560198526fcc4386b4291a">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a4140c70c3728f822d7c0d3ecb3ced1a9">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a4140c70c3728f822d7c0d3ecb3ced1a9">FALSE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a915a6963fd74408e72bc5af5643f21ee">COLLECTION\_NAME</a>: \[DEPRECATED–please specify the containing schema for the view as part of <span className="em">view\_name</span> and use <a className="el" href="#ac754b44062e7b90b8afa50ddfa8ccbf2">createSchema</a> to create the schema if non-existent] The schema for the newly created view. If the schema is non-existent, it will be automatically created. </li>
                </ul>

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

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L36817">36817</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="abd5084f4ad7dd2a84dc4b6c33aaeecbf" />

  <h2 className="memtitle"><span className="permalink"><a href="#abd5084f4ad7dd2a84dc4b6c33aaeecbf">◆ </a></span>FilterByAreaGeometryAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1FilterByAreaGeometryResponse">FilterByAreaGeometryResponse</a> > kinetica.Kinetica.FilterByAreaGeometryAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1FilterByAreaGeometryRequest">FilterByAreaGeometryRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). </p>
      <p>(async) </p>
      <p>The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name <a className="el" href="/content/api/cs/classkinetica_1_1FilterByAreaGeometryRequest#ae3593fed483156317e382ab499166982">view\_name</a> passed in as part of the input.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L36736">36736</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="aa20f9edbbd10124e6dc8a40a8fe041f6" />

  <h2 className="memtitle"><span className="permalink"><a href="#aa20f9edbbd10124e6dc8a40a8fe041f6">◆ </a></span>FilterByAreaGeometryAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1FilterByAreaGeometryResponse">FilterByAreaGeometryResponse</a> > kinetica.Kinetica.FilterByAreaGeometryAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">view\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">column\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IList\< double ></td>
                <td className="paramname"><span className="paramname"><span className="em">x\_vector</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IList\< double ></td>
                <td className="paramname"><span className="paramname"><span className="em">y\_vector</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). </p>
      <p>(async) </p>
      <p>The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name <span className="em">view\_name</span> passed in as part of the input.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">table\_name</td>
              <td>Name of the table to filter, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. This may be the name of a table or a view (when chaining queries).</td>
            </tr>

            <tr>
              <td className="paramname">view\_name</td>
              <td>If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Must not be an already existing table or view. The default value is ''.</td>
            </tr>

            <tr>
              <td className="paramname">column\_name</td>
              <td>Name of the geospatial geometry column to be filtered.</td>
            </tr>

            <tr>
              <td className="paramname">x\_vector</td>
              <td>List of x coordinates of the vertices of the polygon representing the area to be filtered.</td>
            </tr>

            <tr>
              <td className="paramname">y\_vector</td>
              <td>List of y coordinates of the vertices of the polygon representing the area to be filtered.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a2ef0d670887ea9b7a33f549113c3e9b5">CREATE\_TEMP\_TABLE</a>: If <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a1c88f4fe15560198526fcc4386b4291a">TRUE</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <span className="em">view\_name</span> . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryResponse_1_1Info#ac91bcdf84850987dfa3dbf8030d3fef1">QUALIFIED\_VIEW\_NAME</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a1c88f4fe15560198526fcc4386b4291a">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a4140c70c3728f822d7c0d3ecb3ced1a9">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a4140c70c3728f822d7c0d3ecb3ced1a9">FALSE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1FilterByAreaGeometryRequest_1_1Options#a915a6963fd74408e72bc5af5643f21ee">COLLECTION\_NAME</a>: \[DEPRECATED–please specify the containing schema for the view as part of <span className="em">view\_name</span> and use <a className="el" href="#ac754b44062e7b90b8afa50ddfa8ccbf2">createSchema</a> to create the schema if non-existent] The schema for the newly created view. If the schema is non-existent, it will be automatically created. </li>
                </ul>

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

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L36906">36906</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>