Skip to main content
interface FilterByRadiusRequest
options?: Record<string, string>;
radius: number;
table_name: string;
view_name?: string;
x_center: number;
x_column_name: string;
y_center: number;
y_column_name: string;
options? radius table_name view_name? x_center x_column_name y_center y_column_name
options?: Record<string, string>

Optional parameters.

radius: number

The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of ‘42000’ means 42 km.

table_name: string

Name of the table on which the filter by radius 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.

x_center: number

Value of the longitude of the center. Must be within [-180.0, 180.0].

x_column_name: string

Name of the column to be used for the x-coordinate (the longitude) of the center.

y_center: number

Value of the latitude of the center. Must be within [-90.0, 90.0].

y_column_name: string

Name of the column to be used for the y-coordinate-the latitude-of the center.