Class: Raster<ArrayType, GridType, MapType>
Defined in: Fill.ts:236
A raster (i.e. pixel) plot
Grid Compatibility
- ✅
PlateCarreeGrid - ✅
PlateCarreeRotatedGrid - ✅
LambertGrid - ❌
UnstructuredGrid - ✅
RadarSweepGrid - ✅
Geostationary
Example
// Create a raster plot with the provided color map
const raster = new Raster(wind_speed_field, {cmap: color_map});
Extends
PlotComponentFill<ArrayType,GridType,MapType>
Type Parameters
| Type Parameter |
|---|
ArrayType extends TypedArray |
GridType extends DomainBufferGrid |
MapType extends MapLikeType |
Constructors
Constructor
new Raster<
ArrayType,GridType,MapType>(field,opts):Raster<ArrayType,GridType,MapType>
Defined in: Fill.ts:243
Create a raster plot
Parameters
| Parameter | Type | Description |
|---|---|---|
field | ExpressionScalarField<ArrayType, GridType> | The field to create the raster plot from |
opts | RasterOptions | Options for creating the raster plot |
Returns
Raster<ArrayType, GridType, MapType>
Overrides
PlotComponentFill<ArrayType, GridType, MapType>.constructor
Properties
| Property | Modifier | Type | Inherited from | Defined in |
|---|---|---|---|---|
cmap_mag_filter | protected | number | null | PlotComponentFill.cmap_mag_filter | Fill.ts:84 |
image_mag_filter | protected | number | null | PlotComponentFill.image_mag_filter | Fill.ts:83 |
opts | readonly | Required<ContourFillOptions> | PlotComponentFill.opts | Fill.ts:76 |
Methods
updateField()
updateField(
field,mask?):Promise<void>
Defined in: Fill.ts:251
Update the data displayed as a raster plot
Parameters
| Parameter | Type | Description |
|---|---|---|
field | ExpressionScalarField<ArrayType, GridType> | The new field to display as a raster plot |
mask? | Uint8Array | - |
Returns
Promise<void>
Overrides
PlotComponentFill.updateField