Skip to main content
interface FilterByAreaRequest
options?: Record<string, string>;
table_name: string;
view_name?: string;
x_column_name: string;
x_vector: number[];
y_column_name: string;
y_vector: number[];
options? table_name view_name? x_column_name x_vector y_column_name y_vector
options?: Record<string, string>

Optional parameters.

table_name: string

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?: string

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.

x_column_name: string

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

x_vector: number[]

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

y_column_name: string

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

y_vector: number[]

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