Skip to main content

Class: ContourLabels<ArrayType, GridType, MapType>

Defined in: Contour.ts:280

Label the contours on a plot

Example

// Contour some data
const contours = new Contour(height_field, {color: '#000000', interval: 30});
// Label the contours
const labels = new ContourLabels(contours, {text_color: '#ffffff', halo: true});

Extends

Type Parameters

Type Parameter
ArrayType extends TypedArray
GridType extends StructuredGrid
MapType extends MapLikeType

Constructors

Constructor

new ContourLabels<ArrayType, GridType, MapType>(contours, opts?): ContourLabels<ArrayType, GridType, MapType>

Defined in: Contour.ts:286

Parameters

ParameterType
contoursContour<ArrayType, GridType, MapType>
opts?ContourLabelOptions

Returns

ContourLabels<ArrayType, GridType, MapType>

Overrides

PlotComponent.constructor

Methods

updateField()

updateField(): Promise<void>

Defined in: Contour.ts:299

Update contour labels when the field for the associated Contour object has been changed.

Returns

Promise<void>