Skip to main content
interface FilterByBoxGeometryRequest
column_name: string;
max_x: number;
max_y: number;
min_x: number;
min_y: number;
options?: Record<string, string>;
table_name: string;
view_name?: string;
column_name max_x max_y min_x min_y options? table_name view_name?
column_name: string

Name of the geospatial geometry column to be filtered.

max_x: number

Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to min_x.

max_y: number

Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to min_y.

min_x: number

Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to max_x.

min_y: number

Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to max_y.

options?: Record<string, string>

Optional parameters.

table_name: string

Name of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.

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.