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

◆ filterByArea() \[1/2]

FilterByAreaResponse kinetica.Kinetica.filterByArea ( FilterByAreaRequest request\_ )
inline

Calculates which objects from a table are within a named area of interest (NAI/polygon).

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 view\_name passed in as part of the input.

Parameters
request\_ Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 36488 of file KineticaFunctions.cs.

◆ filterByArea() \[2/2]

FilterByAreaResponse kinetica.Kinetica.filterByArea ( string table\_name,
string view\_name,
string x\_column\_name,
IList\< double > x\_vector,
string y\_column\_name,
IList\< double > y\_vector,
IDictionary\< string, string > options = null )
inline

Calculates which objects from a table are within a named area of interest (NAI/polygon).

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 view\_name passed in as part of the input.

Parameters
table\_name Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view\_name If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
x\_column\_name Name of the column containing the x values to be filtered.
x\_vector List of x coordinates of the vertices of the polygon representing the area to be filtered.
y\_column\_name Name of the column containing the y values to be filtered.
y\_vector List of y coordinates of the vertices of the polygon representing the area to be filtered.
options Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_VIEW\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 36594 of file KineticaFunctions.cs.

◆ FilterByAreaAsync() \[1/2]

async System.Threading.Tasks.Task\< FilterByAreaResponse > kinetica.Kinetica.FilterByAreaAsync ( FilterByAreaRequest request\_,
System.Threading.CancellationToken cancellationToken = default )
inline

Calculates which objects from a table are within a named area of interest (NAI/polygon).

(async)

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 view\_name passed in as part of the input.

Parameters
request\_ Request object containing the parameters for the operation.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 36511 of file KineticaFunctions.cs.

◆ FilterByAreaAsync() \[2/2]

async System.Threading.Tasks.Task\< FilterByAreaResponse > kinetica.Kinetica.FilterByAreaAsync ( string table\_name,
string view\_name,
string x\_column\_name,
IList\< double > x\_vector,
string y\_column\_name,
IList\< double > y\_vector,
IDictionary\< string, string > options = null,
System.Threading.CancellationToken cancellationToken = default )
inline

Calculates which objects from a table are within a named area of interest (NAI/polygon).

(async)

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 view\_name passed in as part of the input.

Parameters
table\_name Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
view\_name If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
x\_column\_name Name of the column containing the x values to be filtered.
x\_vector List of x coordinates of the vertices of the polygon representing the area to be filtered.
y\_column\_name Name of the column containing the y values to be filtered.
y\_vector List of y coordinates of the vertices of the polygon representing the area to be filtered.
options Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_VIEW\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
The default value is an empty Dictionary.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 36684 of file KineticaFunctions.cs.