Browse the classes, functions, and other entities of the API.
Gui API
Describes API entities for creating, querying, and manipulating GUI elements.
Modeling API
Describes API entities to interact with scene data such as tools, strokes, curves, and ZSpheres.
System API
Describes API entities to interact with system features such as file handling, the timeline, and more.
| Category | Option | Description |
|---|---|---|
| Query | The search does not support special search operators. Terms are joined by default with OR unless the AND join mode is enabled. Queries can contain search literals denoted by double quotes. E.g., foo bar would search for documents that contain foo and/or bar (depending on the selected join option). But "foo bar" would search for the exact phrase "foo bar". The search is case-insensitive. Note that search literals will always implicitly enable strict search mode, even when the user has selected fuzzy mode. |
|
| / | Toggles the visibility of the facet selection panel. | |
| / | Toggles the visibility of this help panel. | |
| OR / AND | Toggles between joining search terms with a logical OR or AND. In OR mode, the search will return results that match any of the search terms, while in AND mode, it will only return results that match all of the search terms. | |
| / | Toggles between fuzzy and strict mode when searching. In fuzzy mode, the search is more lenient and may return more results, while in strict mode, the search is more exacting. Switching modes may affect the relevance of the results. | |
| / | Toggles between detailed and compact result views. The detailed view shows more information per search hit. | |
| / | Toggles sorting the search results by relevance only or by a combination of classification and relevance. When sorting by classification and relevance, results are grouped by their type (e.g., pages, classes, methods) and then sorted by relevance within each group. | |
| Facets | Facets restrict the search to specific content types. You must have at least one facet enabled per facet group to see any results. Domain is the largest facet group, enabling or disabling whole groups of content types. Entities are the next level down, allowing you to search within specific types of content such as generic pages or a function definition. Contexts are the most granular level, allowing you to search within specific contexts of the selected entity such as a code block ot the name of an entity. | |
| Domain | API | Enable matches within API documentation pages. |
| Manuals | Enable matches within general documentation pages. | |
| Examples | Enable matches within example pages. | |
| Entity | Page | Enable matches within a page body that are not one of the following entities. |
| Classes | Enable matches within class definitions. | |
| Methods | Enable matches within class method definitions. | |
| Functions | Enable matches within module function definitions. | |
| Attributes | Enable matches within class or module attribute definitions. | |
| Context | Paragraphs | Enable matches within normal text paragraphs of a page. |
| Headings | Enable matches within the headings of a page. | |
| Code | Enable matches within code blocks of a page (e.g., in the Examples domain or code blocks embed elsewhere). | |
| Names |
Enable matches within the names of API entities. This searches the plain names (func), not the qualified
names (foo.bar.func).
|
|
| Signatures |
Enable matches within the signatures of API entities. The signature is what is shown on top of the entity description, e.g.,
foo.bar.func(a: int, b: str = "Hello") -> bool. When you want to search for fully qualified
names, you should enable this option and disable the "Names" option.
|
|
| Metadata | Enable matches within the metadata of entities. |