Altair EEvision 2025.1 APIs
    Preparing search index...

    Type Alias ExtractPathsOptions

    Options for configuring the EEvisionAPI.ExtractPaths function.

    type ExtractPathsOptions = {
        ignoreArcs: boolean;
        ignoreGround: boolean;
        ignoreMultiterms: boolean;
        ignorePower: boolean;
        preciseAppear: boolean;
        startColor: string | null;
    }
    Index

    Properties

    ignoreArcs: boolean

    If true, do not follow electrical connections within a component (so-called arcs).

    ignoreGround: boolean

    If true, do not follow ground wires.

    ignoreMultiterms: boolean

    If true, do not treat multi-term connections (several wires at the same cavity) as electrical connections between the wires.

    ignorePower: boolean

    If true, do not follow power wires.

    preciseAppear: boolean

    If true, only the actual terminal object is highlighted, e.g., in case of a component, only the component body, but not its connectors or cavities. If false, connectors of terminal components are highlighted as well.

    startColor: string | null

    Color that is used to highlight the terminal objects. If it is null, the object is not highlighted.