Header menu logo issie

WaveSimStyle Module

Functions to style the DOM elements used in waveform simulator

Types

Type Description

RamRowType

Functions and values

Function or value Description

backgroundSVG wsModel count

Full Usage: backgroundSVG wsModel count

Parameters:
Returns: ReactElement list

Grid lines separating clock cycles

wsModel : WaveSimModel
count : int
Returns: ReactElement list

boldFontStyle

Full Usage: boldFontStyle

Returns: CSSProp list
Returns: CSSProp list

calcNamesColWidth ws

Full Usage: calcNamesColWidth ws

Parameters:
Returns: int

Calculate the necessary with of the naes column based on the longest name.

ws : WaveSimModel
Returns: int

calcWaveformAndScrollBarHeight wsModel

Full Usage: calcWaveformAndScrollBarHeight wsModel

Parameters:
Returns: float
wsModel : WaveSimModel
Returns: float

calcWaveformHeight wsModel

Full Usage: calcWaveformHeight wsModel

Parameters:
Returns: float

The height the waveform table wants: one row per waveform DRAWN, which is a selected wave that AllWaves still holds, plus the row of clock cycle numbers above them.

wsModel : WaveSimModel
Returns: float

centerAlignStyle

Full Usage: centerAlignStyle

Returns: HTMLAttr
Returns: HTMLAttr

checkboxInputProps

Full Usage: checkboxInputProps

Returns: IHTMLProp list

Props for Checkbox.Input

Returns: IHTMLProp list

checkboxStyle

Full Usage: checkboxStyle

Returns: HTMLAttr

Style of checkboxes

Returns: HTMLAttr

clkCycleBut height

Full Usage: clkCycleBut height

Parameters:
    height : 'a

Returns: CSSProp list

List of Style properties for clock cycle button

height : 'a
Returns: CSSProp list

clkCycleButtonStyle

Full Usage: clkCycleButtonStyle

Returns: HTMLAttr

Style for clock cycle buttons

Returns: HTMLAttr

clkCycleInnerStyle

Full Usage: clkCycleInnerStyle

Returns: HTMLAttr

Style for inner clock cycle buttons (buttons to move by one clock cycle)

Returns: HTMLAttr

clkCycleInputProps

Full Usage: clkCycleInputProps

Returns: IHTMLProp list

Props for clock cycle text Input field No AutoFocus. React focuses an autofocused element every time it mounts, so this box took the keyboard whenever the viewer's control row was rebuilt - on Start, and after a cursor move or a zoom. The keyboard then belonged to a text field, and the Left and Right arrows that step the cursor stopped working until something else was clicked. You click into a box to type in it; SelectedComponentView's name box says the same thing for the same reason.

Returns: IHTMLProp list

clkCycleInputStyle

Full Usage: clkCycleInputStyle

Returns: HTMLAttr

Style for clock cycle text Input field

Returns: HTMLAttr

clkCycleLeftStyle

Full Usage: clkCycleLeftStyle

Returns: HTMLAttr

Style for left-most clock cycle button

Returns: HTMLAttr

clkCycleNumberRowProps m

Full Usage: clkCycleNumberRowProps m

Parameters:
Returns: IProp list

Props for row of clock cycle numbers

m : WaveSimModel
Returns: IProp list

clkCycleRightStyle

Full Usage: clkCycleRightStyle

Returns: HTMLAttr

Style for right-most clock cycle button

Returns: HTMLAttr

clkCycleSVGStyle

Full Usage: clkCycleSVGStyle

Returns: HTMLAttr

Style for clock cycle number row

Returns: HTMLAttr

clkCycleText m i

Full Usage: clkCycleText m i

Parameters:
Returns: IProp list

Props for text in clock cycle row

m : WaveSimModel
i : int
Returns: IProp list

clkLineStyle

Full Usage: clkLineStyle

Returns: HTMLAttr

Style of line separating clock cycles

Returns: HTMLAttr

cursorCycleHighlightSVG m dispatch

Full Usage: cursorCycleHighlightSVG m dispatch

Parameters:
Returns: ReactElement

Controls the background highlighting of which clock cycle is selected

m : WaveSimModel
dispatch : Msg -> unit
Returns: ReactElement

detailsProps showDetails cBox ws dispatch

Full Usage: detailsProps showDetails cBox ws dispatch

Parameters:
Returns: IHTMLProp list

Props for HTML Details element

showDetails : bool
cBox : CheckBoxStyle
ws : WaveSimModel
dispatch : Msg -> Unit
Returns: IHTMLProp list

endCycle wsModel

Full Usage: endCycle wsModel

Parameters:
Returns: int

Right-most visible clock cycle.

wsModel : WaveSimModel
Returns: int

errorMessageStyle

Full Usage: errorMessageStyle

Returns: HTMLAttr

Style for showing error messages in waveform simulator.

Returns: HTMLAttr

eyeSvg colour size

Full Usage: eyeSvg colour size

Parameters:
    colour : string
    size : string

Returns: ReactElement

Eye, drawn to the size of the box it is given. Marks the button which shows a waveform's component on the schematic.

colour : string
size : string
Returns: ReactElement

nameLabelStyle isHovered

Full Usage: nameLabelStyle isHovered

Parameters:
    isHovered : bool

Returns: HTMLAttr

Style for name label

isHovered : bool
Returns: HTMLAttr

nameRowLevelLeftProps visibility

Full Usage: nameRowLevelLeftProps visibility

Parameters:
    visibility : string

Returns: IHTMLProp list

Prop for Level.left in name row.

visibility : string
Returns: IHTMLProp list

nameRowLevelStyle isHovered

Full Usage: nameRowLevelStyle isHovered

Parameters:
    isHovered : bool

Returns: HTMLAttr

Style for Bulma level element in name row

isHovered : bool
Returns: HTMLAttr

namesColBackground fill line

Full Usage: namesColBackground fill line

Parameters:
    fill : string
    line : (int * string * bool) option

Returns: CSSProp list

Background for the names column, or for one row of it. The strip at the left, where the view button sits, is painted as pane rather than as column, so that the button reads as standing outside the line the labels start on - which is what it is. The delete cross is inside that line, because it belongs to the label. Any line along the row starts at that same place rather than running out into the strip. It is painted as a second background layer, since a border cannot be inset. The line is given as thickness, colour, and whether it goes along the top of the element rather than the bottom.

fill : string
line : (int * string * bool) option
Returns: CSSProp list

namesColumnProps ws

Full Usage: namesColumnProps ws

Parameters:
Returns: IHTMLProp list

Props for names column

ws : WaveSimModel
Returns: IHTMLProp list

namesColumnStyle ws

Full Usage: namesColumnStyle ws

Parameters:
Returns: HTMLAttr

Style properties for names column

ws : WaveSimModel
Returns: HTMLAttr

normalFontStyle

Full Usage: normalFontStyle

Returns: CSSProp list
Returns: CSSProp list

plainTopRowLine

Full Usage: plainTopRowLine

Returns: CSSProp list

The line under the top row of the values column, which has no strip to keep clear of.

Returns: CSSProp list

pointsToString points

Full Usage: pointsToString points

Parameters:
Returns: string

Convert XYPos list to string

points : XYPos array
Returns: string

radixTabAStyle

Full Usage: radixTabAStyle

Returns: HTMLAttr

Style for A HTML element in radixTabs

Returns: HTMLAttr

radixTabProps

Full Usage: radixTabProps

Returns: IHTMLProp list

Props for radix tabs

Returns: IHTMLProp list

radixTabsStyle

Full Usage: radixTabsStyle

Returns: HTMLAttr

Style for radixTabs

Returns: HTMLAttr

ramRowStyle

Full Usage: ramRowStyle

Returns: HTMLAttr

Style for row in ramTable

Returns: HTMLAttr

ramTableLevelProps

Full Usage: ramTableLevelProps

Returns: IHTMLProp list

Props for Bulma Level element for single ramTable

Returns: IHTMLProp list

ramTableRowStyle rowType

Full Usage: ramTableRowStyle rowType

Parameters:
Returns: CSSProp list

Style for each row of ramTable

rowType : RamRowType
Returns: CSSProp list

ramTablesLevelProps

Full Usage: ramTablesLevelProps

Returns: IHTMLProp list

Props for Bulma Level element for ramTables

Returns: IHTMLProp list

screenHeight ()

Full Usage: screenHeight ()

Parameters:
    () : unit

Returns: float
() : unit
Returns: float

screenWidth ()

Full Usage: screenWidth ()

Parameters:
    () : unit

Returns: float
() : unit
Returns: float

scrollbarClkCycleLeftStyle

Full Usage: scrollbarClkCycleLeftStyle

Returns: HTMLAttr

Style for left-most clock cycle button

Returns: HTMLAttr

scrollbarClkCycleRightStyle

Full Usage: scrollbarClkCycleRightStyle

Returns: HTMLAttr

Button style for scrollbar's right button. Left button uses clkCycleLeftStyle.

Returns: HTMLAttr

selectRamButtonProps buttonId

Full Usage: selectRamButtonProps buttonId

Parameters:
    buttonId : string

Returns: Option list
buttonId : string
Returns: Option list

selectRamButtonPropsLight buttonId

Full Usage: selectRamButtonPropsLight buttonId

Parameters:
    buttonId : string

Returns: Option list

Props for selectRamButton when no RAMs are selectable

buttonId : string
Returns: Option list

selectWavesButtonProps

Full Usage: selectWavesButtonProps

Returns: string -> bool -> Option list

Props for selectWavesButton

Returns: string -> bool -> Option list

selectWavesButtonPropsLight buttonId

Full Usage: selectWavesButtonPropsLight buttonId

Parameters:
    buttonId : string

Returns: Option list

Props for selectWavesButton when no waves are selectable

buttonId : string
Returns: Option list

selectedWaves wsModel

Full Usage: selectedWaves wsModel

Parameters:
Returns: Wave list

The waves the viewer draws: those the user has selected that the simulation still holds. All three columns are built from this, so it is also what a row number means anything against.

wsModel : WaveSimModel
Returns: Wave list

separatorColour

Full Usage: separatorColour

Returns: string
Returns: string

setSelectionOpen cBox show wsModel

Full Usage: setSelectionOpen cBox show wsModel

Parameters:
Returns: WaveSimModel
cBox : CheckBoxStyle
show : bool
wsModel : WaveSimModel
Returns: WaveSimModel

setWaveGroupSelectionOpen wsModel grps show

Full Usage: setWaveGroupSelectionOpen wsModel grps show

Parameters:
Returns: WaveSimModel

Sets or clears a subset of ShowGroupDetail

wsModel : WaveSimModel
grps : (ComponentGroup * string list) list
show : bool
Returns: WaveSimModel

setWaveSheetSelectionOpen wsModel subSheets show

Full Usage: setWaveSheetSelectionOpen wsModel subSheets show

Parameters:
    wsModel : WaveSimModel
    subSheets : string list list
    show : bool

Returns: WaveSimModel

Open or close nodes of the wave selector's hierarchy, each named by its path of design-time sheet names. Opening one closes any other node of the same sheet. A sheet that several routes reach appears in several places, and showing more than one of them at once is the multiplying that collapsing the hierarchy is there to prevent. Where only one route reaches a sheet this is vacuous - there is only one such node - so the rule needs no test for which kind of sheet it is.

wsModel : WaveSimModel
subSheets : string list list
show : bool
Returns: WaveSimModel

setWaveToolTip m ev

Full Usage: setWaveToolTip m ev

Parameters:

Change Tooltip SVG element based on mouse position.

m : WaveSimModel
ev : MouseEvent

showWaveformsAndRamStyle height

Full Usage: showWaveformsAndRamStyle height

Parameters:
    height : float

Returns: HTMLAttr
height : float
Returns: HTMLAttr

showWaveformsStyle

Full Usage: showWaveformsStyle

Returns: HTMLAttr

Style for waveforms only path of viewer

Returns: HTMLAttr

singleValueOnWaveProps isStart textFont textWeight xpos

Full Usage: singleValueOnWaveProps isStart textFont textWeight xpos

Parameters:
    isStart : bool
    textFont : float
    textWeight : 'a
    xpos : 'b - Starting X-direction position.

Returns: IProp list

Props for displaying values on non-binary waves by starting position.

isStart : bool
textFont : float
textWeight : 'a
xpos : 'b

Starting X-direction position.

Returns: IProp list

singleWaveWidth m

Full Usage: singleWaveWidth m

Parameters:
Returns: float

Width of one clock cycle.

m : WaveSimModel
Returns: float

summaryProps isSummary cBox ws dispatch

Full Usage: summaryProps isSummary cBox ws dispatch

Parameters:
Returns: IHTMLProp list

Props for HTML Summary element True if this is a summary element, false if it is a details element. isSummary is used to determine if the click handler is used.

isSummary : bool
cBox : CheckBoxStyle
ws : WaveSimModel
dispatch : Msg -> Unit
Returns: IHTMLProp list

svgWaveToolTip ws

Full Usage: svgWaveToolTip ws

Parameters:
Returns: ReactElement

SVG group element for tooltip. The props of the tooltip, as well as its text, are set in the function changeToolTip. Initial props make it invisible.

ws : WaveSimModel
Returns: ReactElement

topHalfButtonProps

Full Usage: topHalfButtonProps

Returns: IColor -> string -> bool -> Option list
Returns: IColor -> string -> bool -> Option list

topHalfButtonPropsLoading isLoading color buttonId isRightSide

Full Usage: topHalfButtonPropsLoading isLoading color buttonId isRightSide

Parameters:
    isLoading : bool
    color : IColor
    buttonId : string
    isRightSide : bool

Returns: Option list
isLoading : bool
color : IColor
buttonId : string
isRightSide : bool
Returns: Option list

topHalfStyle

Full Usage: topHalfStyle

Returns: HTMLAttr

Style for top half of waveform simulator (instructions and buttons)

Returns: HTMLAttr

topRow ws background topRowContent

Full Usage: topRow ws background topRowContent

Parameters:
Returns: ReactElement list

Empty row used in namesColumn and valuesColumn. Shifts these down by one to allow for the row of clk cycle numbers in waveformsColumn. The background carries the line under the row: the names column insets that line past the view button strip, the values column has no strip and draws it as a plain border.

ws : WaveSimModel
background : CSSProp list
topRowContent : ReactElement seq
Returns: ReactElement list

topRowButtonStyle isRightSide

Full Usage: topRowButtonStyle isRightSide

Parameters:
    isRightSide : bool

Returns: HTMLAttr

Style for top row of buttons

isRightSide : bool
Returns: HTMLAttr

valueColumnTextStyle wsModel

Full Usage: valueColumnTextStyle wsModel

Parameters:
Returns: Text
wsModel : WaveSimModel
Returns: Text

valueLabelStyle ws

Full Usage: valueLabelStyle ws

Parameters:
Returns: HTMLAttr

Style for value label

ws : WaveSimModel
Returns: HTMLAttr

valueTopPadding ws

Full Usage: valueTopPadding ws

Parameters:
Returns: float
ws : WaveSimModel
Returns: float

valuesColumnSize wsModel

Full Usage: valuesColumnSize wsModel

Parameters:
Returns: int * int
wsModel : WaveSimModel
Returns: int * int

valuesColumnStyle ws colWidth

Full Usage: valuesColumnStyle ws colWidth

Parameters:
Returns: HTMLAttr

Style properties for values column

ws : WaveSimModel
colWidth : int
Returns: HTMLAttr

viewBoxMinX m

Full Usage: viewBoxMinX m

Parameters:
    m : 'a

Returns: string

Left-most coordinate of the SVG viewbox.

m : 'a
Returns: string

viewBoxWidth m

Full Usage: viewBoxWidth m

Parameters:
Returns: string

Total width of the SVG viewbox.

m : WaveSimModel
Returns: string

viewSymbolButtonStyle isInView

Full Usage: viewSymbolButtonStyle isInView

Parameters:
    isInView : bool

Returns: HTMLAttr

Style of the button which shows a waveform's component on the schematic. It sits in a slot of its own at the outer edge of the name row, beyond the delete icon, so that it reads as an extra beside the label rather than as one of the label's own controls. Green when the component cannot be seen and grey when it is already in front of the user; shown only while the row is hovered.

isInView : bool
Returns: HTMLAttr

viewWaveSimStyle

Full Usage: viewWaveSimStyle

Returns: HTMLAttr

Style for viewWaveSim

Returns: HTMLAttr

wavePolyfillStyle points

Full Usage: wavePolyfillStyle points

Parameters:
Returns: IProp list
points : XYPos array
Returns: IProp list

wavePolylineStyle points

Full Usage: wavePolylineStyle points

Parameters:
Returns: IProp list

Style of polyline used to draw waveforms

points : XYPos array
Returns: IProp list

waveRowProps m

Full Usage: waveRowProps m

Parameters:
Returns: IProp list

Props for each row in waveform column

m : WaveSimModel
Returns: IProp list

waveRowSVGStyle

Full Usage: waveRowSVGStyle

Returns: HTMLAttr

Style for each row in waveform column

Returns: HTMLAttr

waveRowsStyle wsModel

Full Usage: waveRowsStyle wsModel

Parameters:
Returns: HTMLAttr

Style for rows in waveforms column

wsModel : WaveSimModel
Returns: HTMLAttr

waveSimColumn

Full Usage: waveSimColumn

Returns: CSSProp list

List of Style properties for columns in wave viewer.

Returns: CSSProp list

waveformColumnRowProps m

Full Usage: waveformColumnRowProps m

Parameters:
Returns: IProp list

Props for waveform column rows

m : WaveSimModel
Returns: IProp list

waveformColumnStyle

Full Usage: waveformColumnStyle

Returns: HTMLAttr

Style for waveforms column

Returns: HTMLAttr

zoomInSVG

Full Usage: zoomInSVG

Returns: ReactElement
Returns: ReactElement

zoomOutSVG

Full Usage: zoomOutSVG

Returns: ReactElement
Returns: ReactElement

Type something to start searching.