Skip to main content

Class: Hodographs<GridType, MapType>

Defined in: Hodographs.ts:133

A class representing a field of hodograph plots

Grid Compatibility​

  • ✅ PlateCarreeGrid
  • ✅ PlateCarreeRotatedGrid
  • ✅ LambertGrid
  • ✅ UnstructuredGrid
  • ❌ RadarSweepGrid
  • ❌ Geostationary

Extends​

Type Parameters​

Type Parameter
GridType extends AutoZoomGrid
MapType extends MapLikeType

Constructors​

Constructor​

new Hodographs<GridType, MapType>(profile_field, opts?): Hodographs<GridType, MapType>

Defined in: Hodographs.ts:148

Create a field of hodographs

Parameters​

ParameterTypeDescription
profile_fieldRawProfileField<GridType>The grid of profiles to plot
opts?HodographOptionsVarious options to use when creating the hodographs

Returns​

Hodographs<GridType, MapType>

Overrides​

PlotComponent.constructor

Properties​

PropertyModifierTypeDefined in
optsreadonlyRequired<HodographOptions>Hodographs.ts:135

Methods​

updateField()​

updateField(field): Promise<void>

Defined in: Hodographs.ts:166

Update the profiles displayed

Parameters​

ParameterTypeDescription
fieldRawProfileField<GridType>The new profiles to display as hodographs

Returns​

Promise<void>