SearchableParameterList - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > SearchableParameterList

SearchableParameterList class

Searchable parameters list. Container for different types of values.

Signature:

export declare class SearchableParameterList extends GemList<GemParameter>

Extends: GemList<GemParameter>

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SearchableParameterList class.

Methods

Method	Modifiers	Description
add(parameter)		Adds a parameter to the list
asJson()		Returns the parameters as a deeply structured JSON list. Each entry includes the key, value, and, if available, name. The value is formatted according to its type. Only parameters with non-null key, value, and type are included.
create(mapId, parameterList)	`static`	Creates a new SearchableParameterList instance
dispose()
findAll(key)		Search for all occurrences of a parameter identifier in a list.
findByName(key)		Search for first occurrence of a parameter identifier and get the name of the parameter.
findParameter(key)		Search for first occurrence of a parameter identifier.