Models
Last updated
Was this helpful?
Last updated
Was this helpful?
Once you've specified a Data Source, you can easily access a widget model using any of the functions in this a page. This is a basic usage example for a category model that can be used to build a bar chart.
All models support a set of , but there are several types of widget models, each of them returning a different data model more suitable for a type of data visualization:
When using vector-based sources (vectorTableSource
, vectorQuerySource
...), all models support the following options:
signal (optional): Allows you to cancel ongoing requests, saving data warehouse resources and free up computing and queuing capacity.
When using spatial index-based sources (h3TableSource
, h3QuerySource
, quadbinTableSource
, quadbinQuerySource
...), all models support the following options:
spatialFilterPolyfillMode (optional): Used to determine how the spatial index cells are filtered according to the spatialFilter
. Default value is intersects
. Accepted values are:
center
: filters only spatial index cells whose center is inside the spatialFilter
polygon.
intersects
: filters only spatial index cells that intersect the spatialFilter
polygon. This is the default value.
contains
: filters only spatial index cells that are entirely contained inside the spatialFilter
polygon.
abortController (optional): Allows you to cancel ongoing requests, saving data warehouse resources and free up computing and queuing capacity.
abortController (optional): Allows you to cancel ongoing requests, saving data warehouse resources and free up computing and queuing capacity.
When using raster-based sources (rasterTableSource
), all models support the following options:
abortController (optional): Allows you to cancel ongoing requests, saving data warehouse resources and free up computing and queuing capacity.
spatialFilter (optional): Used for filtering a widget based on a geometry, such as a user input or the current deck.gl map view state. Learn more about .
filterOwner (optional): This widget will be excluded from all column filters with a matching owner
property. In other words, filters with a matching owner
property won't filter this widget's data. The most common use case for this is when filters are originated based on user interactions with the widget. .
spatialFilter (optional): Used for filtering a widget based on a geometry, such as a user input or the current deck.gl map view state. Learn more about .
filterOwner (optional): This widget will be excluded from all column filters with a matching owner
property. In other words, filters with a matching owner
property won't filter this widget's data. The most common use case for this is when filters are originated based on user interactions with the widget. .
When using tileset sources (, , ...), all models support the following options:
spatialFilter: Used for filtering a widget based on a geometry, such as a user input or the current deck.gl map view state. Learn more about .
filterOwner (optional): This widget will be excluded from all column filters with a matching owner
property. In other words, filters with a matching owner
property won't filter this widget's data. The most common use case for this is when filters are originated based on user interactions with the widget. .
filters (optional): A valid object, used to perform client-side filtering of this widget model with column-based filters.
Models in tileset sources are calculated client-side. Read more about .
spatialFilter: Used for filtering a widget based on a geometry, such as a user input or the current deck.gl map view state. Learn more about .
filterOwner (optional): This widget will be excluded from all column filters with a matching owner
property. In other words, filters with a matching owner
property won't filter this widget's data. The most common use case for this is when filters are originated based on user interactions with the widget. .
filters (optional): A valid object, used to perform client-side filtering of this widget model with column-based filters.
Models in tileset sources are calculated client-side. Read more about .