Skip to main content

Symbol queries

In the boards system, queries can emit many symbols as an array, whereas picks allow you to emit symbols individually. Non-emitted queries are also useful, for example when looking for symbols of a certain type in a complex board diagram.

Creating a query​

  1. Go to the DATA screen, and click the QUERIES tab:

    QUERIES tab

  2. Click the "NEW QUERY" button to create your query.

  3. Specify the symbol type to be included in your query. It's possible to include multiple symbol types.

    For now, symbol type is the only available filter. In the future, you will be able to define rules to exclude certain symbols based on their data.

If you want your query to generate a DATA block to be used by your program:

  1. Mark the "EMIT" checkbox.

  2. Specify a class name. If you only selected one symbol type, generally it's the same as the symbol type name. If your query combines multiple symbol types, then the class should be a common base class of all possible classes.

A preview of the emitted declarations will appear on the right. On the CODE screen, the emitted declaration can also be found in the [GENERATED] source file.