Last updated

API / geotoolkit / map / features / formatters / SingleField / SingleField

Class: SingleField

formatters.SingleField.SingleField

Features info formatter based on the one attribute field.

Implements

Table of contents

Constructors
Methods

Contents

Constructors

new SingleField(field, separator, limit, unique)

new SingleField(field?, separator?, limit?, unique?)

Features info formatter based on the one attribute field.

Parameters

Name Type Description
Optional fieldstringfield to show, id is used if no value provided
Optional separatorstringhtml separator between different features info (e.g use ', ' for comma-separated list)
Optional limitnumberupper limit for the aggregated features are shown
Optional uniquebooleantrue to filter repeating fields
Methods

format

format(features, text): string

Formats html text based on the provided features attribute field

Parameters

Name Type Description
featuresAbstractFeature[]features list to format
textstringtext created by the previous formatters from other layers

Returns

string

text the formatted text result

Implementation of

IFormatter.format


getClassName

getClassName(): string

Returns

string


getClassName

Static getClassName(): string

Returns

string