# GetLayerHistogramParams

***

The params used to request a histogram of values from a layer, passed to the [LayersController.getHistogramData](/js-sdk-api-reference/layers/layerscontroller.md#gethistogramdata) method.

## Properties

### layerId

> **layerId**: `string`

***

### attribute

> **attribute**: `string`

***

### steps

> **steps**: `number`\[] | { `type`: `"equal-intervals"`; `count`: `number`; } | { `type`: `"time-interval"`; `interval`: `"hour"` | `"day"` | `"week"` | `"month"` | `"year"`; }

***

### values?

> `optional` **values**: { `boundary`: \[`number`, `number`]\[] | \[`number`, `number`, `number`, `number`] | { `type`: `"Polygon"`; `coordinates`: \[`number`, `number`]\[]\[]; } | { `type`: `"MultiPolygon"`; `coordinates`: \[`number`, `number`]\[]\[]\[]; }; `filters`: `null` | `boolean` | \[`null` | `string`, `"in"` | `"ni"`, `null` | (`null` | `string` | `number` | `boolean`)\[]] | \[`null` | `string`, `"lt"` | `"gt"` | `"le"` | `"ge"` | `"eq"` | `"ne"` | `"cn"` | `"nc"` | `"is"` | `"isnt"`, `null` | `string` | `number` | `boolean`] | [`FilterTernary`](/js-sdk-api-reference/layers/filterternary.md); `aggregation`: { `method`: `"min"` | `"max"` | `"avg"` | `"sum"` | `"median"`; `attribute`: `string`; }; }

Configuration for filtering and aggregating values while preserving the full set of bin ranges in the results.

This is particularly useful when you want to compare different subsets of data while maintaining consistent ranges. For example:

* Use the same height ranges for comparing old vs new buildings

Unlike top-level filters which affect both what ranges appear AND their values, filters in this configuration only affect the values while keeping all possible ranges in the results.

| Name                    | Type                                                                                                                                                                                                                                                                                                                                                                     | Default value         | Description                                                                 |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------- | --------------------------------------------------------------------------- |
| `boundary`?             | \[`number`, `number`]\[] \| \[`number`, `number`, `number`, `number`] \| { `type`: `"Polygon"`; `coordinates`: \[`number`, `number`]\[]\[]; } \| { `type`: `"MultiPolygon"`; `coordinates`: \[`number`, `number`]\[]\[]\[]; }                                                                                                                                            | -                     | -                                                                           |
| `filters`?              | `null` \| `boolean` \| \[`null` \| `string`, `"in"` \| `"ni"`, `null` \| (`null` \| `string` \| `number` \| `boolean`)\[]] \| \[`null` \| `string`, `"lt"` \| `"gt"` \| `"le"` \| `"ge"` \| `"eq"` \| `"ne"` \| `"cn"` \| `"nc"` \| `"is"` \| `"isnt"`, `null` \| `string` \| `number` \| `boolean`] \| [`FilterTernary`](/js-sdk-api-reference/layers/filterternary.md) | -                     | -                                                                           |
| `aggregation`?          | { `method`: `"min"` \| `"max"` \| `"avg"` \| `"sum"` \| `"median"`; `attribute`: `string`; }                                                                                                                                                                                                                                                                             | -                     | -                                                                           |
| `aggregation.method`    | `"min"` \| `"max"` \| `"avg"` \| `"sum"` \| `"median"`                                                                                                                                                                                                                                                                                                                   | AggregateMethodSchema | The operation to use on the values from the features in the layer           |
| `aggregation.attribute` | `string`                                                                                                                                                                                                                                                                                                                                                                 | -                     | The attribute to use for the aggregation. This must be a numeric attribute. |

***

### filters?

> `optional` **filters**: [`Filters`](/js-sdk-api-reference/layers/filters.md)

Attribute filters for the features to include when calculating the histogram bins.

***

### boundary?

> `optional` **boundary**: [`GeometryFilter`](/js-sdk-api-reference/layers/geometryfilter.md)

The spatial boundary for the features to include when calculating the histogram bins.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.felt.com/js-sdk-api-reference/layers/getlayerhistogramparams.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.