Altair EEvision 2025.1 APIs
    Preparing search index...

    Type Alias LiveSearchOptions

    Options for the EEvisionAPI.LiveSearch command.

    type LiveSearchOptions = {
        otype: ObjectType | "any" | "most";
        searchAttrs: readonly string[];
        searchMax: number;
        searchMode: LiveSearchMode;
        stype: string | null;
    }
    Index

    Properties

    otype: ObjectType | "any" | "most"

    Type of object to search for (e.g., "component", "connector", ...). If the value is "any", objects of all types are taken into consideration (including cavities); if the value is "most", then all types except cavities are considered.

    "any"

    searchAttrs: readonly string[]

    List of attribute that EEvision should take into account for the search.

    []

    searchMax: number

    Maximum number of search results to return.

    A value of 0 means: unlimited.

    0

    searchMode: LiveSearchMode

    Specifies whether EEvision should search the whole EDB database on the server (value "edb") or only the currently displayed schematic (value "scm").

    "edb"

    stype: string | null

    Limit the search to objects of a certain subtype (e.g., for wire to power or ground wires). If the value is null, all objects of the current type are taken into consideration.

    null