Documentation - v20.0.0-dev
    Preparing search index...

    Settings of the search: the quick search of the toolbar and the advanced search widget.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    enableAI: BooleanController = ...

    Shows the button opening a prompt that makes the filter from a description in natural language, in the advanced search widget. It needs the Tia API URL of the Teia plugin (settings.tiaApiUrl).

    enableJsonEditor: BooleanController = ...

    Shows the button opening the filter in a JSON editor, in the advanced search widget.

    icon: "picking" = 'picking'

    Drawn by an interface before its title.

    inputConditions: SearchConditionsController = ...

    The conditions applied to every pattern entered in the quick search (patterns split by ;).

    Name, GUID and type conditions
    
    isCategory: boolean = false

    A category of the group holding it: drawn by an interface inside that group (e.g. the post-processing's antialiasing and ambient occlusion), which stays a group of its own even without settings of its own (a group of groups only is drawn in place, e.g. the engine's).

    isSettings: true

    Tells a group of settings from a setting, without instanceof.

    title: "Search" = 'Search'

    Shown by an interface above its settings.

    Methods

    • Sets the settings config gives, each validated (see ValueController.validate): a value refused is skipped with a warning, the others set. The keys that are not settings are ignored (e.g. of a config saved by another version).

      Parameters

      Returns void

    • Disconnects every listener of the settings: they are not used after.

      Returns void

    • Sets the settings saved under key in the local storage (saveToLocalStorage); none saved: unchanged. A value refused (e.g. by a later version) is skipped with a warning, the others set (see applyConfig); saved settings that cannot be read are ignored with a warning.

      Parameters

      • key: string

      Returns void

    • Sets every setting back to its default.

      Returns void

    • Saves the values changed from their default under key in the local storage, the key removed when none is: the others follow the defaults of the next versions.

      Parameters

      • key: string

      Returns void