issie


CommonTypes

Namespace: global

Nested types and modules

TypeDescription
CanvasState

F# data describing the contents of a single schematic sheet.

Component

JSComponent mapped to F# record. Id uniquely identifies the component within a sheet and is used by draw2d library. Label is optional descriptor displayed on schematic.

ComponentType
Connection

JSConnection mapped to F# record. Id uniquely identifies connection globally and is used by library.

CustomComponentType

Name identified the LoadedComponent used. The labels define legends on symbol. Label strings are unique per CustomComponent. Multiple CustomComponent instances are differentiated by Component data.

HighLightColor

Colors to highlight components Case name is used (lowercase) as HTML color name See JSHelpers.getColorString lots of colors can be added, see https://www.w3schools.com/colors/colors_names.asp

LoadedComponent

Static data describing a schematic sheet loaded as a custom component. Every sheet is always identified with a file from which it is loaded/saved. Name is human readable (and is the filename - without extension) and identifies sheet. File path is the sheet directory and name (with extension). InputLabels, OutputLabels are the I/O connections. The I/O connection integers are bus widths. The I/O connection strings are human readable. The strings are guaranteed to be unique in the I/O connection list. I.e. An input label may be the same as an output label, but two input (or output) labels cannot be the same. The position in the I/O connections list is important as it implicitly indicates the port number. For example, the first element in the InputLabels list is related to the Component's Port with PortNumber 0. Two instances of a loaded component have the same LoadedComponent data.

Memory
NumberBase
Port

A component I/O. Id (like any other Id) is a string generated with 32 random hex charactes, so it is (practically) globally unique. These Ids are used by the draw2d library to uniquely refer to ports and components. They are generated via: http://www.draw2d.org/draw2d_touch/jsdoc_6/#!/api/draw2d.util.UUID. PortNumber is used to identify which port on a component, contiguous from 0 separately for inputs and outputs. HostId is the unique Id of the component where the port is. For example, all three ports on the same And component will have the same HostId.

PortType
Project

Type for an open project which represents a complete design. ProjectPath is directory containing project files. OpenFileName is name of file from which current schematic sheet is loaded/saved. LoadedComponents contains the list of schematic sheets, each as a component, one per sheet.

Functions and values

Function or valueDescription
draw2dCanvasHeight
Signature: int
draw2dCanvasWidth
Signature: int