elasticsearch-js/docs/reference/api/SearchMvtRequest.md

SearchMvtRequest [interface-SearchMvtRequest]

Name	Type	Description
aggs	Record<string, AggregationsAggregationContainer>	Sub-aggregations for the geotile_grid. It supports the following aggregation types: - avg - boxplot - cardinality - extended stats - max - median absolute deviation - min - percentile - percentile-rank - stats - sum - value countThe aggregation names can't start with _mvt_. The _mvt_ prefix is reserved for internal aggregations.
body	string	({ [key: string]: any; } & { index?: never; field?: never; zoom?: never; x?: never; y?: never; aggs?: never; buffer?: never; exact_bounds?: never; extent?: never; fields?: never; grid_agg?: never; grid_precision?: never; grid_type?: never; query?: never; runtime_mappings?: never; size?: never; sort?: never; track_total_hits?: never; with_labels?: never; })
buffer	integer	The size, in pixels, of a clipping buffer outside the tile. This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile.
exact_bounds	boolean	If false, the meta layer's feature is the bounding box of the tile. If true, the meta layer's feature is a bounding box resulting from a geo_bounds aggregation. The aggregation runs on values that intersect the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting bounding box may be larger than the vector tile.
extent	integer	The size, in pixels, of a side of the tile. Vector tiles are square with equal sides.
field	Field	Field containing geospatial data to return
fields	Fields	The fields to return in the hits layer. It supports wildcards ( *). This parameter does not support fields with array values. Fields with array values may return inconsistent results.
grid_agg	SearchMvtGridAggregationType	The aggregation used to create a grid for the field.
grid_precision	integer	Additional zoom levels available through the aggs layer. For example, if <zoom> is 7 and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results don't include the aggs layer.
grid_type	SearchMvtGridType	Determines the geometry type for features in the aggs layer. In the aggs layer, each feature represents a geotile_grid cell. If grid, each feature is a polygon of the cells bounding box. If point ` , each feature is a Point that is the centroid of the cell.
index	Indices	Comma-separated list of data streams, indices, or aliases to search
query	QueryDslQueryContainer	The query DSL used to filter documents for the search.
querystring	{ [key: string]: any; } & { index?: never; field?: never; zoom?: never; x?: never; y?: never; aggs?: never; buffer?: never; exact_bounds?: never; extent?: never; fields?: never; grid_agg?: never; grid_precision?: never; grid_type?: never; query?: never; runtime_mappings?: never; size?: never; sort?: never; track_total_hits?: never; with_labels?: never; }	All values in querystring will be added to the request querystring.
runtime_mappings	MappingRuntimeFields	Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.
size	integer	The maximum number of features to return in the hits layer. Accepts 0-10000. If 0, results don't include the hits layer.
sort	Sort	Sort the features in the hits layer. By default, the API calculates a bounding box for each feature. It sorts features based on this box's diagonal length, from longest to shortest.
track_total_hits	SearchTrackHits	The number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query.
with_labels	boolean	If true, the hits and aggs layers will contain additional point features representing suggested label positions for the original features. * Point and MultiPoint features will have one of the points selected. * Polygon and MultiPolygon features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. * LineString features will likewise provide a roughly central point selected from the triangle-tree. * The aggregation results will provide one central point for each aggregation bucket. All attributes from the original features will also be copied to the new label features. In addition, the new features will be distinguishable using the tag _mvt_label_position.
x	SearchMvtCoordinate	X coordinate for the vector tile to search
y	SearchMvtCoordinate	Y coordinate for the vector tile to search
zoom	SearchMvtZoomLevel	Zoom level for the vector tile to search