Skip to main content

Function: getSoilParametersDescription()

getSoilParametersDescription(locale): SoilParameterDescription

Defined in: fdm-core/src/soil.ts:438

Retrieves a description of the available soil parameters.

This function returns an array of objects, each describing a soil parameter. Each description includes the parameter's name, unit, type (numeric or enum), a human-readable name, a detailed description, and optional constraints like minimum and maximum values or a list of valid options for enum types.

Parameters

locale

string = "NL-nl"

The locale for which to retrieve the descriptions. Currently only 'NL-nl' is supported.

Returns

SoilParameterDescription

An array of SoilParameterDescriptionItem objects.

Throws

If an unsupported locale is provided.