> ## 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. # kinetica.FilterByAreaRequest > kinetica.FilterByAreaRequest — Kinetica C# API

A set of parameters for Kinetica.filterByArea. More...

Inheritance diagram for kinetica.FilterByAreaRequest:
Collaboration diagram for kinetica.FilterByAreaRequest:

Classes
struct   Options
  A set of string constants for the parameter FilterByAreaRequest.options. More...
 

Public Member Functions
  FilterByAreaRequest ()
  Constructs a FilterByAreaRequest object with default parameters.
 
  FilterByAreaRequest (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)
  Constructs a FilterByAreaRequest object with the specified parameters.
 
  FilterByAreaRequest ()
  Constructs a FilterByAreaRequest object with default parameters.
 
  FilterByAreaRequest (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)
  Constructs a FilterByAreaRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  table\_name \[get, set]
  Name of the table to filter, in \[schema\_name.
 
string  view\_name = "" \[get, set]
  If provided, then this will be the name of the view containing the results, in \[schema\_name.
 
string  x\_column\_name \[get, set]
  Name of the column containing the x values to be filtered.
 
IList\< double >  x\_vector = new List\() \[get, set]
  List of x coordinates of the vertices of the polygon representing the area to be filtered.
 
string  y\_column\_name \[get, set]
  Name of the column containing the y values to be filtered.
 
IList\< double >  y\_vector = new List\() \[get, set]
  List of y coordinates of the vertices of the polygon representing the area to be filtered.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.filterByArea.

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

Definition at line 22 of file FilterByArea.cs.

Constructor & Destructor Documentation

◆ FilterByAreaRequest() \[1/4]

kinetica.FilterByAreaRequest.FilterByAreaRequest ( )
inline

Constructs a FilterByAreaRequest object with default parameters.

Definition at line 156 of file FilterByArea.cs.

◆ FilterByAreaRequest() \[2/4]

kinetica.FilterByAreaRequest.FilterByAreaRequest ( 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

Constructs a FilterByAreaRequest object with the specified parameters.

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

Definition at line 225 of file FilterByArea.cs.

◆ FilterByAreaRequest() \[3/4]

kinetica.FilterByAreaRequest.FilterByAreaRequest ( )
inline

Constructs a FilterByAreaRequest object with default parameters.

Definition at line 156 of file FilterByArea.cs.

◆ FilterByAreaRequest() \[4/4]

kinetica.FilterByAreaRequest.FilterByAreaRequest ( 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

Constructs a FilterByAreaRequest object with the specified parameters.

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

Definition at line 225 of file FilterByArea.cs.

Property Documentation

◆ options

IDictionary\< string, string > kinetica.FilterByAreaRequest.options = new Dictionary\()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 152 of file FilterByArea.cs.

◆ table\_name

string kinetica.FilterByAreaRequest.table\_name
getset

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

Definition at line 79 of file FilterByArea.cs.

◆ view\_name

string kinetica.FilterByAreaRequest.view\_name = ""
getset

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

Definition at line 89 of file FilterByArea.cs.

◆ x\_column\_name

string kinetica.FilterByAreaRequest.x\_column\_name
getset

Name of the column containing the x values to be filtered.

Definition at line 93 of file FilterByArea.cs.

◆ x\_vector

IList\< double > kinetica.FilterByAreaRequest.x\_vector = new List\()
getset

List of x coordinates of the vertices of the polygon representing the area to be filtered.

Definition at line 97 of file FilterByArea.cs.

◆ y\_column\_name

string kinetica.FilterByAreaRequest.y\_column\_name
getset

Name of the column containing the y values to be filtered.

Definition at line 101 of file FilterByArea.cs.

◆ y\_vector

IList\< double > kinetica.FilterByAreaRequest.y\_vector = new List\()
getset

List of y coordinates of the vertices of the polygon representing the area to be filtered.

Definition at line 105 of file FilterByArea.cs.

The documentation for this class was generated from the following files: