SymbolStyleSearchParameters

Search parameters used to search for symbol primitives in a symbol style . SymbolStyleSearchParameters allow you to specify different parameters when searching a symbol style with SymbolStyle.searchSymbols. For example, you may want to search for any symbols where the category is "2", the name contains "destroyed", and the tags contain "Protection Lines".

This object allows you to set the parameters in order to perform a search on symbol style . You can make a copy of this and pass it or reuse it for different search.

Since

200.1.0

See also

Constructors

Link copied to clipboard
constructor()

Creates a new Symbol Style Search Parameters object. This object is a collection of name, class, category, tags and keys. Symbol style performs a search based on that and looks for all the symbols matching these entries in stylx file.

constructor(names: Iterable<String>)

Creates a new Symbol Style Search Parameters object with the specified names.

Properties

Link copied to clipboard

The string list of categories defined in the database to be used for search. For example, with mil2525d you may want to search for symbols where the categories are "Activities : Main Icon" or "Sea Surface : Main Icon".

Link copied to clipboard

A boolean showing if the categories parameter is to be matched exactly against the database. A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

Link copied to clipboard

A boolean showing if all the parameters are empty.

Link copied to clipboard

A string list of all the keys(unique identifiers) used for search. For example, with mil2525d you may want to search for symbols where the keys are "25272100" or "2_635_1c".

Link copied to clipboard

A boolean showing if the keys parameter is to be matched exactly against the database. A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

Link copied to clipboard

The string list of names to be used for search. For example, with mil2525d you may want to search for symbols where the names are "Ship Propulsion : Nuclear Powered" or "Simulation : Friend : Air".

Link copied to clipboard

A boolean showing if the names parameter is to matched exactly against the database. A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

Link copied to clipboard

A string list of all the symbol classes(symbol types) used for search. e.g. Point, Line, Polygon For example, with mil2525d you may want to search for symbols where the symbol classes are "3" (Point Symbol) or "7" (North Arrow).

Link copied to clipboard

A boolean showing if the symbol classes parameter is to be matched exactly against the database. A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.

Link copied to clipboard

The string list of tags to be used for search. For example, with mil2525d you may want to search for symbols where the tags include "Airspace Control Points" or "Meteorological - Oceanographic".

Link copied to clipboard

A boolean showing if the tags parameter is to matched exactly against the database. A strict match will force the search to use "=", as opposed to "LIKE". The default value is false.