Header menu logo issie

WaveSimSelectHelpers Module

Types and nested modules

Type/Module Description

Constants

TableRow

WaveSelectionOutput

Type to output the selected waves and a flag for whether to show detailed view.

Functions and values

Function or value Description

checkBoxItem wsModel isChecked waveIds dispatch

Full Usage: checkBoxItem wsModel isChecked waveIds dispatch

Parameters:
Returns: ReactElement
wsModel : WaveSimModel
isChecked : bool
waveIds : WaveIndexT list
dispatch : Msg -> unit
Returns: ReactElement

checkboxRow wsModel dispatch index

Full Usage: checkboxRow wsModel dispatch index

Parameters:
Returns: TableRow
wsModel : WaveSimModel
dispatch : Msg -> unit
index : WaveIndexT
Returns: TableRow

componentSearchBox wsModel dispatch

Full Usage: componentSearchBox wsModel dispatch

Parameters:
Returns: ReactElement

Search box for component names.

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

ensureWaveConsistency ws

Full Usage: ensureWaveConsistency ws

Parameters:
Returns: Wave list * WaveIndexT list

Ensures that only valid waves (and selected waves) are returned.

ws : WaveSimModel
Returns: Wave list * WaveIndexT list

filterWaves wsModel

Full Usage: filterWaves wsModel

Parameters:
Returns: (type)

Filtering function that applies an AND operation across four search criteria. OfSheet is used to return the waves that match the sheet box All returns all filtered waves without any sheet filtering.

wsModel : WaveSimModel
Returns: (type)

getComponentName wave

Full Usage: getComponentName wave

Parameters:
Returns: string
wave : Wave
Returns: string

infoButton

Full Usage: infoButton

Returns: ReactElement
Returns: ReactElement

isSubSheetOf subSheetId sheets

Full Usage: isSubSheetOf subSheetId sheets

Parameters:
    subSheetId : string
    sheets : string list

Returns: bool
subSheetId : string
sheets : string list
Returns: bool

makeFlatGroupRow showDetails ws grp wavesInGroup dispatch

Full Usage: makeFlatGroupRow showDetails ws grp wavesInGroup dispatch

Parameters:
Returns: TableRow
showDetails : bool
ws : WaveSimModel
grp : ComponentGroup
wavesInGroup : Wave list
dispatch : Msg -> unit
Returns: TableRow

makePortRow ws dispatch waves

Full Usage: makePortRow ws dispatch waves

Parameters:
Returns: TableRow
ws : WaveSimModel
dispatch : Msg -> unit
waves : Wave list
Returns: TableRow

makeSelectionTable ws waves dispatch

Full Usage: makeSelectionTable ws waves dispatch

Parameters:
Returns: ReactElement
ws : WaveSimModel
waves : Wave list
dispatch : Msg -> unit
Returns: ReactElement

makeSummaryItem showDetails ws summaryItem rows cBox waves dispatch

Full Usage: makeSummaryItem showDetails ws summaryItem rows cBox waves dispatch

Parameters:
Returns: TableRow

Makes a summary row which is one row of a table and can be expanded to show more details presented as a sub-table. The details are passed as: rows - a list of TableRow elements each representing a component with some ports or a group of components. waves: the corresponding list of waveforms to display. In general waves.Length > rows.Length since one row will typically have multiple ports and therefore multiple waves. The summary item is the ReactElement to display in the summary row: it is given Style etc from summaryProps.

showDetails : bool
ws : WaveSimModel
summaryItem : ReactElement
rows : TableRow list
cBox : CheckBoxStyle
waves : Wave list
dispatch : Msg -> unit
Returns: TableRow

portSearchBox wsModel dispatch

Full Usage: portSearchBox wsModel dispatch

Parameters:
Returns: ReactElement

Search box for port names.

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

searchBoxContainerStyle

Full Usage: searchBoxContainerStyle

Returns: HTMLAttr

A style to add some margin between search boxes.

Returns: HTMLAttr

selectAll wsModel dispatch

Full Usage: selectAll wsModel dispatch

Parameters:
Returns: ReactElement
wsModel : WaveSimModel
dispatch : Msg -> unit
Returns: ReactElement

selectAllSubsheetsBox ws dispatch

Full Usage: selectAllSubsheetsBox ws dispatch

Parameters:
Returns: ReactElement
ws : WaveSimModel
dispatch : Msg -> unit
Returns: ReactElement

selectWavesModal wsModel dispatch model

Full Usage: selectWavesModal wsModel dispatch model

Parameters:
Returns: ReactElement

Displays the modal for wave selection. The top row shows the serach boxes. Below a two‑column grid shows the wave selection (left) and breadcrumbs (right).

wsModel : WaveSimModel
dispatch : Msg -> unit
model : Model
Returns: ReactElement

sheetSearchBox wsModel dispatch

Full Usage: sheetSearchBox wsModel dispatch

Parameters:
Returns: ReactElement

Search box for sheet names.

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

showOnlySelectedBox ws dispatch

Full Usage: showOnlySelectedBox ws dispatch

Parameters:
Returns: ReactElement
ws : WaveSimModel
dispatch : Msg -> unit
Returns: ReactElement

toggleSelectAll selected wsModel dispatch

Full Usage: toggleSelectAll selected wsModel dispatch

Parameters:
selected : bool
wsModel : WaveSimModel
dispatch : Msg -> unit

toggleSelectSubGroup wsModel dispatch selected waves

Full Usage: toggleSelectSubGroup wsModel dispatch selected waves

Parameters:
wsModel : WaveSimModel
dispatch : Msg -> unit
selected : bool
waves : WaveIndexT list

toggleWaveSelection index wsModel dispatch

Full Usage: toggleWaveSelection index wsModel dispatch

Parameters:
index : WaveIndexT
wsModel : WaveSimModel
dispatch : Msg -> unit

updateSheetString newSheetName ws

Full Usage: updateSheetString newSheetName ws

Parameters:
Returns: string
newSheetName : string
ws : WaveSimModel
Returns: string

waveCheckBox (arg1, arg2) isChecked action name ws dispatch

Full Usage: waveCheckBox (arg1, arg2) isChecked action name ws dispatch

Parameters:
Returns: ReactElement

Checkbox to select all subsheets.

arg0 : WaveSimModel -> 'STATE
arg1 : 'STATE -> WaveSimModel -> WaveSimModel
isChecked : 'STATE -> bool
action : bool -> 'STATE -> 'STATE
name : string
ws : WaveSimModel
dispatch : Msg -> unit
Returns: ReactElement

waveCheckBoxItem wsModel waveIds dispatch

Full Usage: waveCheckBoxItem wsModel waveIds dispatch

Parameters:
Returns: ReactElement
wsModel : WaveSimModel
waveIds : WaveIndexT list
dispatch : Msg -> unit
Returns: ReactElement

wavePropsTable rows

Full Usage: wavePropsTable rows

Parameters:
Returns: ReactElement
rows : TableRow list
Returns: ReactElement

waveRow props rowItems

Full Usage: waveRow props rowItems

Parameters:
    props : CSSProp list
    rowItems : 'a list

Returns: TableRow
props : CSSProp list
rowItems : 'a list
Returns: TableRow

waveRowIProps props rowItems

Full Usage: waveRowIProps props rowItems

Parameters:
Returns: TableRow
props : IHTMLProp seq
rowItems : 'a list
Returns: TableRow

waveSearchBox wsModel dispatch

Full Usage: waveSearchBox wsModel dispatch

Parameters:
Returns: ReactElement

Search box for wave names.

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

waveSelectBreadcrumbs wsModel filteredWaves dispatch model

Full Usage: waveSelectBreadcrumbs wsModel filteredWaves dispatch model

Parameters:
Returns: ReactElement

Displays a breadcrumb of sheets based on the current search and wave matches.

wsModel : WaveSimModel
filteredWaves : (type)
dispatch : Msg -> unit
model : Model
Returns: ReactElement

Type something to start searching.