Skip to main content

Class: ContourFill<ArrayType, GridType, MapType>

Defined in: Fill.ts:289

A filled contoured field

Grid Compatibility

  • PlateCarreeGrid
  • PlateCarreeRotatedGrid
  • LambertGrid
  • UnstructuredGrid
  • RadarSweepGrid
  • Geostationary

Example

// Create a field of filled contours with the provided color map
const fill = new ContourFill(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 ContourFill<ArrayType, GridType, MapType>(field, opts): ContourFill<ArrayType, GridType, MapType>

Defined in: Fill.ts:296

Create a filled contoured field

Parameters

ParameterTypeDescription
fieldExpressionScalarField<ArrayType, GridType>The field to create filled contours from
optsContourFillOptionsOptions for creating the filled contours

Returns

ContourFill<ArrayType, GridType, MapType>

Overrides

PlotComponentFill<ArrayType, GridType, MapType>.constructor

Properties

PropertyModifierTypeInherited fromDefined in
cmap_mag_filterprotectednumber | nullPlotComponentFill.cmap_mag_filterFill.ts:84
image_mag_filterprotectednumber | nullPlotComponentFill.image_mag_filterFill.ts:83
optsreadonlyRequired<ContourFillOptions>PlotComponentFill.optsFill.ts:76

Methods

updateField()

updateField(field, mask?): Promise<void>

Defined in: Fill.ts:304

Update the data displayed as filled contours

Parameters

ParameterTypeDescription
fieldExpressionScalarField<ArrayType, GridType>The new field to display as filled contours
mask?Uint8Array-

Returns

Promise<void>

Overrides

PlotComponentFill.updateField