Header menu logo issie

SymbolView Module

Functions and values

Function or value Description

addClock pos colour opacity

Full Usage: addClock pos colour opacity

Parameters:
    pos : XYPos
    colour : string
    opacity : float

Returns: ReactElement list
pos : XYPos
colour : string
opacity : float
Returns: ReactElement list

addHorizontalColorLine posX1 posX2 posY opacity color

Full Usage: addHorizontalColorLine posX1 posX2 posY opacity color

Parameters:
    posX1 : 'a
    posX2 : 'b
    posY : 'c
    opacity : float
    color : string

Returns: ReactElement list
posX1 : 'a
posX2 : 'b
posY : 'c
opacity : float
color : string
Returns: ReactElement list

addHorizontalLine posX1 posX2 posY opacity

Full Usage: addHorizontalLine posX1 posX2 posY opacity

Parameters:
    posX1 : 'a
    posX2 : 'b
    posY : 'c
    opacity : float

Returns: ReactElement list
posX1 : 'a
posX2 : 'b
posY : 'c
opacity : float
Returns: ReactElement list

addLegendText pos name alignment weight size

Full Usage: addLegendText pos name alignment weight size

Parameters:
    pos : XYPos
    name : string
    alignment : string
    weight : string
    size : string

Returns: ReactElement list

Add one or two lines of text, two lines are marked by a . delimiter

pos : XYPos
name : string
alignment : string
weight : string
size : string
Returns: ReactElement list

addStyledText pos text name

Full Usage: addStyledText pos text name

Parameters:
Returns: ReactElement

Text adding function using text record

pos : XYPos
text : Text
name : string
Returns: ReactElement

addText pos name alignment weight size

Full Usage: addText pos name alignment weight size

Parameters:
    pos : XYPos
    name : string
    alignment : string
    weight : string
    size : string

Returns: ReactElement list

Text adding function with many parameters (such as bold, position and text)

pos : XYPos
name : string
alignment : string
weight : string
size : string
Returns: ReactElement list

createAnyPath startingPoint pathAttr colour strokeWidth outlineColour

Full Usage: createAnyPath startingPoint pathAttr colour strokeWidth outlineColour

Parameters:
    startingPoint : XYPos
    pathAttr : string
    colour : string
    strokeWidth : string
    outlineColour : string

Returns: ReactElement list
startingPoint : XYPos
pathAttr : string
colour : string
strokeWidth : string
outlineColour : string
Returns: ReactElement list

createBiColorPolygon points colour strokeColor opacity strokeWidth comp

Full Usage: createBiColorPolygon points colour strokeColor opacity strokeWidth comp

Parameters:
    points : string
    colour : string
    strokeColor : string
    opacity : float
    strokeWidth : string
    comp : Component

Returns: ReactElement list
points : string
colour : string
strokeColor : string
opacity : float
strokeWidth : string
comp : Component
Returns: ReactElement list

createPath startingPoint startingControlPoint endingControlPoint endingPoint

Full Usage: createPath startingPoint startingControlPoint endingControlPoint endingPoint

Parameters:
Returns: ReactElement list
startingPoint : XYPos
startingControlPoint : XYPos
endingControlPoint : XYPos
endingPoint : XYPos
Returns: ReactElement list

createPolygon points colour opacity

Full Usage: createPolygon points colour opacity

Parameters:
    points : string
    colour : string
    opacity : float

Returns: ReactElement list
points : string
colour : string
opacity : float
Returns: ReactElement list

drawComponent symbol theme

Full Usage: drawComponent symbol theme

Parameters:
Returns: ReactElement list

Draw symbol (and its label) using theme for colors, returning a list of React components implementing all of the text and shapes needed.

symbol : Symbol
theme : ThemeType
Returns: ReactElement list

drawCorners showCorners symb

Full Usage: drawCorners showCorners symb

Parameters:
Returns: ReactElement list

HLP23 AUTHOR: BRYAN TAN Draw circles on the corners of custom components when manually resizing them

showCorners : ShowCorners
symb : Symbol
Returns: ReactElement list

drawMovingPortTarget pos symbol outlinePoints

Full Usage: drawMovingPortTarget pos symbol outlinePoints

Parameters:
Returns: ReactElement list

Function to draw the Target of a Moving Port (if there is one)

pos : (XYPos * XYPos) option
symbol : Symbol
outlinePoints : string
Returns: ReactElement list

drawPorts portType portList showPorts symb

Full Usage: drawPorts portType portList showPorts symb

Parameters:
Returns: ReactElement list

Function to draw ports using getPortPos. The ports are equidistant

portType : PortType
portList : List<Port>
showPorts : ShowPorts
symb : Symbol
Returns: ReactElement list

drawPortsText portList listOfNames symb

Full Usage: drawPortsText portList listOfNames symb

Parameters:
    portList : Port list
    listOfNames : string list
    symb : Symbol

Returns: ReactElement list

Print the name of each port

portList : Port list
listOfNames : string list
symb : Symbol
Returns: ReactElement list

init ()

Full Usage: init ()

Parameters:
    () : unit

Returns: Model * Cmd<'a>

init function for initial Symbol Model

() : unit
Returns: Model * Cmd<'a>

outlineColor color

Full Usage: outlineColor color

Parameters:
    color : string

Returns: string
color : string
Returns: string

rotatePoints points centre transform

Full Usage: rotatePoints points centre transform

Parameters:
Returns: XYPos[]

Takes points, height and width of original shape and returns the points for it given a rotation / flipped status. Degree0 rotation has TopLeft = top left coordinate of the outline, which is a box of dimensions W X H. Rotation rotates the box about its centre point, keeping TopLeft fixed.

points : XYPos[]
centre : XYPos
transform : STransform
Returns: XYPos[]

view model dispatch

Full Usage: view model dispatch

Parameters:
Returns: ReactElement
model : Model
dispatch : Msg -> unit
Returns: ReactElement

Type something to start searching.