Type Alias ExtractOneOptions

ExtractOneOptions: {
    extractMax: number;
    ignoreArcs: boolean;
    ignoreGround: boolean;
    ignorePower: boolean;
    markio: boolean;
    preciseAppear: boolean;
    smart: "off" | "only" | "hybrid";
    startColor: string | null;
}

Options for configuring the 1-context extractor of EEvision, see EEvisionAPI.ExtractOne.

Type declaration

  • extractMax: number

    Maximum number of components to return as a result of the Path Extractor. If its value is 0, the number unlimited.

    Default Value

    0

  • ignoreArcs: boolean

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

    Default Value

    false

  • ignoreGround: boolean

    If true, do not follow ground wires.

    Default Value

    false

  • ignorePower: boolean

    If true, do not follow power wires.

    Default Value

    false

  • markio: boolean

    If true and if smart extraction is enabled (see {@link ExtractOneOptions}.smart), then the flow direction from the "smartstop" object is shown using small arrows on the wires.

    Default Value

    false

  • 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, the connectors of extracted components are highlighted as well.

    Default Value

    true

  • smart: "off" | "only" | "hybrid"

    Enables or disables the “smart” extraction feature of EEvisionAPI.ExtractOne. The smart behavior requires that some EDB components, connectors, or cavities are labeled with the attribute "␣smartstop" (with a leading space!). If an electrical network that is connected to the extracted object contains such a “smartstop” object, only those paths of that network that lead to the “smartstop” object are loaded instead of the whole electrical network. Typical examples are that the power source or the main ground eyelet(s) are marked as smartstop.

    The values have the following meaning:

    • "off" disables the smart behavior, i.e., the extractor loads the whole electrical network that is connected to the cavities of the extracted object.
    • "only" limits the extraction to those electrical networks that actually contain a “smartstop” object; electrical networks without such an object are not extracted.
    • "hybrid" loads, for those networks that contain a “smartstop” object, only the paths to this object; for networks without “smartstop” the whole network is loaded.

    Default Value

    hybrid

  • startColor: string | null

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

    Default Value

    null

Settings

Member Visibility