Skip to main content

FeatureDescriptionLabel

Auto-generated from the config schema in the source — see the config guide for concepts. Provided by the features plugin. View source.

The feature displays' labels.description, the line drawn under each feature's name: whether it shows, and the field it reads. A bare string is the field. Shown descriptions still hide where features crowd the screen, a zoom step before names do, whether or not names draw.

Example usage

{ type: 'LinearBasicDisplay', labels: { description: { show: false } } }

Config slots

A setting written to it names members one by one: a member left out stays as it is, and null resets one. Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.

SlotDescription
show
boolean = true		draw a description line under each feature
field
featureField = 
'jexl:get(feature,'note') || get(feature,'description') || get(feature,'function')'
the field the description reads, such as note, or a jexl: expression over feature; the default reads note, else description, else function, and an empty value draws no description