Altair EEvision 2025.1 APIs
    Preparing search index...

    The data for updating the configuration of EEvision.

    interface ConfigUpdate {
        autoOptimize: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
        autoZoom: boolean;
        blockMode: ("-ignore-power" | "-ignore-ground" | "-ignore-arcs")[];
        busWire: string;
        busWireCol: string;
        cavAttrdsp: null | string;
        colorscheme:
            | null
            | Partial<
                {
                    attrcolor: null
                    | string;
                    backgroundcolor: null | string;
                    boxcolor0: null | string;
                    boxcolor3: null | string;
                    boxinstcolor: null | string;
                    boxpincolor: null | string;
                    buscolor: null | string;
                    fillcolor1: null | string;
                    fillcolor2: null | string;
                    fillcolor3: null | string;
                    fillcolor6: null | string;
                    netcolor: null | string;
                    objectgray: null | string;
                    overlaycolor: null | string;
                    portcolor: null | string;
                    rippercolor: null | string;
                    selectionmodecolor: null | string;
                },
            >;
        compAttrdsp: string[];
        connAttrdsp: string[];
        explodeSplices: boolean;
        extractMax: number;
        groundWire: string;
        groundWireCol: string;
        groundWireEx: boolean;
        hierColor: null
        | string;
        hvWire: string;
        hvWireCol: string;
        license:
            | null
            | `http://${string}`
            | `https://${string}`
            | "units"
            | "feature";
        logicalMode: (
            | "-ignore-power"
            | "-ignore-ground"
            | "-ignore-arcs"
            | "-halfdots"
            | "-open-inliners"
        )[];
        logicalWire: string;
        logicalWireCol: string;
        markioEx: boolean;
        multicores: "none"
        | "basic"
        | "full";
        plugins: string[];
        powerWire: string;
        powerWireCol: string;
        powerWireEx: boolean;
        preciseAppear: boolean;
        rectangleColor: string;
        rectangleSelection: "none" | "components" | "wires" | "both";
        rotate90: boolean;
        searchAny: boolean;
        searchAttrs: string[];
        searchMax: number;
        selectColor: null | string;
        signalAttr: null | string;
        sortAttributes: boolean;
        space4wirelabel: boolean;
        startColor: null | string;
        wireBot: boolean;
        wireBotAttr: null | string;
        wireBotFmt: string;
        wireFilterMode: (
            "-arc"
            | "-bus"
            | "-ground"
            | "-hv"
            | "-logical"
            | "-power"
            | "-undef"
        )[];
        wireMark: boolean;
        wireTop: boolean;
        wireTopAttr: null | string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    autoOptimize: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

    Should EEvision optimize the current schematic automatically whenever it changes? This typically leads to clearer schematics, but creates more movement when incrementally expanding the schematic.

    The value of this option is a combination of bits which individually control schematic optimization on certain events.

    BitMeaning
    AutoOptimize.SCHEMATIC = 0x0001 If set, then optimize after each change of the schematic content (but not after position changes, e.g., due to manual user interaction).
    AutoOptimize.CONNECTOR = 0x0002 If set, optimize whenever a connector is opened or closed by clicking on the [+] / [-] button of the connector.
    AutoOptimize.HIERARCHY = 0x0004 If set, optimize whenever a hierarchical component is folded or unfolded.

    The value of the setting is an arbitrary combination of these bits.

    0 (= disabled = AutoOptimize.NONE).

    autoZoom: boolean

    Determines whether EEvision's autoZoom mode is active or not.

    EEvision has an autoZoom mode, in which the schematic is zoomed automatically to fit the canvas whenever the schematic changes.

    Limitation: Expanding and shrinking the connectors of ECU components is currently not covered by the autoZoom mode.

    false

    blockMode: ("-ignore-power" | "-ignore-ground" | "-ignore-arcs")[]

    Flags to be used when switching to logicalMode. They have the following meaning:

    Flag Meaning
    -ignore-arcs Ignore component-internal electrical connections
    -ignore-ground Do not follow ground wires
    -ignore-power Do not follow power wires

    [ "-ignore-arcs", "-ignore-ground", "-ignore-power" ]

    busWire: string

    Determine how buses (i.e., wires with type EdbWireTBUS) should be displayed in EEvision.

    • "std": use the default style for the wire
    • color value (either hexadecimal RGB value like "#FF00FF" for red or one of the SVG color names): Display the wire with the specified color.

    "std"

    busWireCol: string

    Default wire color for the bus wires.

    "#00AA00" (green)

    cavAttrdsp: null | string

    Which attribute should be shown next to cavities of (L)ECUs?

    In contrast to component (CoreConfig.compAttrdsp and connectors (CoreConfig.connAttrdsp), cavities can carry at most one displayed attribute.

    null

    colorscheme:
        | null
        | Partial<
            {
                attrcolor: null
                | string;
                backgroundcolor: null | string;
                boxcolor0: null | string;
                boxcolor3: null | string;
                boxinstcolor: null | string;
                boxpincolor: null | string;
                buscolor: null | string;
                fillcolor1: null | string;
                fillcolor2: null | string;
                fillcolor3: null | string;
                fillcolor6: null | string;
                netcolor: null | string;
                objectgray: null | string;
                overlaycolor: null | string;
                portcolor: null | string;
                rippercolor: null | string;
                selectionmodecolor: null | string;
            },
        >

    The update of Nlview's color scheme. Using null resets the color scheme to Nlview's default (lightblue). Using null or the empty string for individual keys resets the corresponding color to the default.

    compAttrdsp: string[]

    Which component attributes should be shown in addition to the component name above the component?

    [] (empty list)

    connAttrdsp: string[]

    Which connector attributes (of ECUs and inliners) should be shown next to the connector?

    [] (empty list)

    explodeSplices: boolean

    If true, unconnected “pins” of splices and eyelets are displayed; otherwise they are hidden. This feature is useful to see whether all wires that connect to a splice or eyelet are currently displayed in EEvision.

    extractMax: number

    When running extract, the number of components in the result can be limited. The value 0 means: no limit.

    0

    groundWire: string

    Determine how ground wires (i.e., wires with type EdbWireTGROUND) should be displayed in EEvision.

    • "std": use the default style for the wire
    • color value (either hexadecimal RGB value like "#FF00FF" for red or one of the SVG color names): Display the wire with the specified color.

    "std"

    groundWireCol: string

    Default wire color for ground wires.

    "#88540B" (brown)

    groundWireEx: boolean

    If this property has value true, then the extraction algorithms (see EEvisionAPI.ExtractOne, EEvisionAPI.ExtractPaths, and EEvisionAPI.ExtractSteiner) take ground wires into account; otherwise these algorithms do not traverse ground wires.

    true

    hierColor: null | string

    Color used for highlighting matching connectors in a hierarchical design. The value must be a hexadecimal RGB-value of the form "#RRGGBB".

    "#1A1AFF"

    hvWire: string

    Determine how high-voltage wires (i.e., wires with type EdbWireTHV) should be displayed in EEvision.

    • "std": use the default style for the wire
    • color value (either hexadecimal RGB value like "#FF00FF" for red or one of the SVG color names): Display the wire with the specified color.

    "std"

    hvWireCol: string

    Default wire color for the high-voltage wires.

    "#FF8C00" (orange)

    license: null | `http://${string}` | `https://${string}` | "units" | "feature"

    EEvision offers the possibility to use a web service for licensing and to restrict the used license to either a feature-based license or a unit-based license. The values have the following meaning:

    • "units": Use a unit-based license. If no unit-based license is available, licensing fails.
    • "feature": Use a feature-based license. If no feature-based license is available, licensing fails.
    • null: First try unit-based licensing; if no unit-based license is available, try feature-based licensing. Only if both fail, licensing fails.
    • URL: Use a web service for licensing.

    null

    logicalMode: (
        | "-ignore-power"
        | "-ignore-ground"
        | "-ignore-arcs"
        | "-halfdots"
        | "-open-inliners"
    )[]

    Flags to be used when switching to logicalMode. They have the following meaning:

    Flag Meaning
    -halfdots Treat all halfdot cavities of a component as electrically connected
    -ignore-arcs Ignore component-internal electrical connections
    -ignore-ground Do not follow ground wires
    -ignore-power Do not follow ground wires
    -open-inliners Preserve “open” inliners in logical mode

    Also see GuiConfig.signalAttr.

    [ "-ignore-arcs", "-open-inliners" ];

    logicalWire: string

    Determine how logical connections (i.e., wires with type EdbWireTLOGICAL) should be displayed in EEvision.

    • "std": use the default style for the wire
    • color value (either hexadecimal RGB value like "#FF00FF" for red or one of the SVG color names): Display the wire with the specified color.

    "std"

    logicalWireCol: string

    Default wire color for the logical wires.

    "#8080FF" (blue)

    markioEx: boolean

    When running PluginAPI.ExtractOne in “smart” mode (i.e., with {@link ExtractOneOptions}.smart missing or set to true), then mark the flow direction from the “smartstop” node with arrows along the wires.

    false

    multicores: "none" | "basic" | "full"

    Determines how multicores are rendered in EEvision.

    Value Meaning
    "none" Do not show multicores.
    "basic" Only show well-behaving multicores that can be rendered as part of a component.
    "full" Show all multicores (including the ones that require a routing channel).

    "none"

    plugins: string[]

    List of plugins to be loaded by default.

    [] (empty list)

    powerWire: string

    Determine how power wires (i.e., wires with type EdbWireTPOWER) should be displayed in EEvision.

    • "std": use the default style for the wire
    • color value (either hexadecimal RGB value like "#FF00FF" for red or one of the SVG color names): Display the wire with the specified color.

    "std"

    powerWireCol: string

    Default wire color for the power wires.

    "#FF0000" (red)

    powerWireEx: boolean

    If this property has value true, then the extraction algorithms (see EEvisionAPI.ExtractOne, EEvisionAPI.ExtractPaths, and EEvisionAPI.ExtractSteiner) take power wires into account; otherwise these algorithms do not traverse power wires.

    true

    preciseAppear: boolean

    The selection appearance. If true, then selecting a component really only selects the body of the component; if false, then selecting the component also selects all its connectors.

    true

    rectangleColor: string

    Color of the rectangle that is drawn when selecting objects via the rectangleSelection mechanism.

    `"#553399"
    
    rectangleSelection: "none" | "components" | "wires" | "both"

    Allow the selection of objects using <Ctrl> + dragging the mouse with the left button pressed. The values have the following meaning:

    Value Meaning
    "none" the rectangle selection mechanism is disabled.
    "components" only components are selected.
    "wires" only wires are selected.
    "both" both components and wires are selected.

    CoreConfig.rectangleColor for setting the color of the selection rectangle.

    "none"

    rotate90: boolean

    Display the schematic rotated by 90° (i.e., top to bottom instead of left to right).

    false (not rotated)

    searchAny: boolean

    If true, live search includes cavities when selecting "Any". Additionally, the "Cavity" entry is enabled.

    searchAttrs: string[]

    Which attributes should be taken into account in the live search? The field is an array of attribute names.

    [ "Desc", "PartNo", "Alias", "Signal" ]

    searchMax: number

    Maximum number of results to be shown in the live search window.

    20

    selectColor: null | string

    Color used for highlighting selected objects. If set to null, no selection color is applied, but the object is drawn with ticker lines.

    "#D4772A"

    signalAttr: null | string

    This setting defines a wire attribute that is only consulted when computing the logical view – as done when restarting the EEvision GUI with the URL parameter fsig=signalAttr – meaning the signalAttr value is passed to the fsig parameter (this logical view is, e.g., triggered when switching to Logical Mode in the More menu). If this signalAttr setting is not specified, then an empty string will be passed to fsig.

    "Signal"

    sortAttributes: boolean

    Should the attributes in the info window and balloon window be sorted alphabetically?

    false

    space4wirelabel: boolean

    If true, let Nlview reserve space such that the whole wire label can be displayed. Otherwise, the label might be shortened to save space, and the complete label is only shown when hovering over the wire.

    false

    startColor: null | string

    Color used for highlighting objects that were loaded or extracted by the user. This allows to distinguish these objects from others that were added either interactively or by the extraction algorithms. If the value is null, not start color is applied.

    "#1A1AFF"

    wireBot: boolean

    If true, the value of the attribute whose name is given in CoreConfig.wireBotAttr is shown as a wire label (typically below the wire).

    false

    wireBotAttr: null | string

    If CoreConfig.wireBot is true, the value of the wire attribute whose name is given here is shown as a label (typically below the wire).

    "Diameter"

    wireBotFmt: string

    Formatting information (foreground/background color) for displaying the additional wire attribute (see CoreConfig.wireBot and CoreConfig.wireBotAttr). It must be empty or one color (defining the background color of the displayed attribute value) or two colors separated by a space (defining the background and foreground colors of the displayed attribute value).

    For example wireBotFmt = "#ffd080 #000000" displays the attribute value black on beige background.

    "" (empty string)

    wireFilterMode: (
        "-arc"
        | "-bus"
        | "-ground"
        | "-hv"
        | "-logical"
        | "-power"
        | "-undef"
    )[]

    The wires of these types are preserved when switching to wire filter mode. Wires of all types that are not mentioned here are removed. That means if the value is an empty array, then the resulting filtered EDB does not contain any wires anymore.

    Possible values:

    Flag Meaning
    -arc Keep component-internal electrical connections
    -bus Keep bus connections
    -ground Keep ground wires.
    -hv Keep high-voltage wires
    -logical Keep logical connections
    -power Keep power wires
    -undef Keep wires without a dedicated type.

    [ "-bus", "-ground", "-hv", "-power" ]

    This property is deprecated and will be removed in the 2026 release.

    wireMark: boolean

    If true, EEvision displays a small color marker on the wire that shows the color of the wire's cover.

    true

    wireTop: boolean

    Switch between showing the wire name or an arbitrary wire attribute above the wire. If false, the wire name is shown; if true, the value of the attribute whose name is given as the value of CoreConfig.wireTopAttr is displayed.

    false

    wireTopAttr: null | string

    Name of the wire attribute whose value should be shown above the wire (instead of the wire name) if CoreConfig.wireTop is true.

    "Signal"