Header menu logo issie

MiscMenuView Module

Types and nested modules

Type/Module Description

Constants

BreadcrumbConfig

Functions and values

Function or value Description

Button sheetPath buttonDecision label isDisabled model dispatch

Full Usage: Button sheetPath buttonDecision label isDisabled model dispatch

Parameters:
    sheetPath : string
    buttonDecision : ImportDecision option
    label : string
    isDisabled : bool
    model : Model
    dispatch : Msg -> unit

Returns: ReactElement list
sheetPath : string
buttonDecision : ImportDecision option
label : string
isDisabled : bool
model : Model
dispatch : Msg -> unit
Returns: ReactElement list

allRootHierarchiesFromProjectBreadcrumbs cfg dispatch model

Full Usage: allRootHierarchiesFromProjectBreadcrumbs cfg dispatch model

Parameters:
Returns: ReactElement

Breadcrumbs of entire design hierarchy of every root sheet in project Display as a ReactElement the breadcrumbs. rootSheet - root of hierrarchy displayed clickAction - what happens when a given breadcrumb (labelled by its path to root) is clicked.

cfg : BreadcrumbConfig
dispatch : Msg -> unit
model : Model
Returns: ReactElement

createSheetInfo model projectDir dispatch (arg4, arg5)

Full Usage: createSheetInfo model projectDir dispatch (arg4, arg5)

Parameters:
    model : Model
    projectDir : string
    dispatch : Msg -> unit
    arg3 : string
    arg4 : Set<string>

Returns: ReactElement array

for each imported sheet, create layout for its row in the popup table, as well as rows for all its dependencies.

model : Model
projectDir : string
dispatch : Msg -> unit
arg3 : string
arg4 : Set<string>
Returns: ReactElement array

dependencyRow sheetPath model dispatch dependencyPath

Full Usage: dependencyRow sheetPath model dispatch dependencyPath

Parameters:
    sheetPath : string
    model : Model
    dispatch : Msg -> unit
    dependencyPath : string

Returns: ReactElement

prepare information that should display on a row for a dependency of a sheet

sheetPath : string
model : Model
dispatch : Msg -> unit
dependencyPath : string
Returns: ReactElement

getDecisionText path model sheetIsDependency decisionNeeded

Full Usage: getDecisionText path model sheetIsDependency decisionNeeded

Parameters:
    path : string
    model : Model
    sheetIsDependency : bool
    decisionNeeded : bool

Returns: ReactElement

return text that should display in 'Action' column of import sheets popup

path : string
model : Model
sheetIsDependency : bool
decisionNeeded : bool
Returns: ReactElement

getDependents model oldSheetPath newSheetPath

Full Usage: getDependents model oldSheetPath newSheetPath

Parameters:
    model : Model
    oldSheetPath : string
    newSheetPath : string

Returns: string option

given paths from source directory and destination directory of a sheet that needs importing, if it exists in destination directory, return its dependents wrapped in 'Some'. Otherwise return 'None'

model : Model
oldSheetPath : string
newSheetPath : string
Returns: string option

getDependentsFromSheet model sheetName

Full Usage: getDependentsFromSheet model sheetName

Parameters:
    model : Model
    sheetName : string

Returns: (string * string * ((string * int) list * (string * int) list)) list option

Find all sheets that depend on the given sheet in the current project

model : Model
sheetName : string
Returns: (string * string * ((string * int) list * (string * int) list)) list option

gridArea gridPos

Full Usage: gridArea gridPos

Parameters:
Returns: string
gridPos : CSSGridPos
Returns: string

gridBox gap s

Full Usage: gridBox gap s

Parameters:
Returns: ReactElement
gap : string
s : ReactElement seq
Returns: ReactElement

gridElement reactElementId props styleProps pos x

Full Usage: gridElement reactElementId props styleProps pos x

Parameters:
Returns: ReactElement

a Grid item centre justified and occupying given area

reactElementId : string
props : IHTMLProp list
styleProps : CSSProp list
pos : CSSGridPos
x : ReactElement
Returns: ReactElement

hierarchiesHaveDuplicates model

Full Usage: hierarchiesHaveDuplicates model

Parameters:
Returns: bool

is there a duplicate sheet name anywhere in hierarchy?

model : Model
Returns: bool

hierarchyBreadcrumbs cfg dispatch model

Full Usage: hierarchyBreadcrumbs cfg dispatch model

Parameters:
Returns: ReactElement

Breadcrumbs of entire simulated design hierarchy. Display as a ReactElement the breadcrumbs. ClickAction - what happens when a given breadcrumb (labelled by its path to root) is clicked.

cfg : BreadcrumbConfig
dispatch : Msg -> unit
model : Model
Returns: ReactElement

hierarchyFromSheetBreadcrumbs rootSheet cfg dispatch model

Full Usage: hierarchyFromSheetBreadcrumbs rootSheet cfg dispatch model

Parameters:
Returns: ReactElement

Breadcrumbs of entire design hierarchy from given sheet Display as a ReactElement the breadcrumbs. rootSheet - root of hierrarchy displayed clickAction - what happens when a given breadcrumb (labelled by its path to root) is clicked.

rootSheet : string
cfg : BreadcrumbConfig
dispatch : Msg -> unit
model : Model
Returns: ReactElement

importSheet model dispatch

Full Usage: importSheet model dispatch

Parameters:

Import sheet from directory, ask user to sort out dependency issues

model : Model
dispatch : Msg -> unit

importSheetPopup destProjectDir paths sourceProjectDir dispatch

Full Usage: importSheetPopup destProjectDir paths sourceProjectDir dispatch

Parameters:
    destProjectDir : string
    paths : string list
    sourceProjectDir : string
    dispatch : Msg -> unit

Returns: Unit
destProjectDir : string
paths : string list
sourceProjectDir : string
dispatch : Msg -> unit
Returns: Unit

makeBreadcrumbsFromPositions sheetTreeMap cfg positionSheetsInGrid dispatch

Full Usage: makeBreadcrumbsFromPositions sheetTreeMap cfg positionSheetsInGrid dispatch

Parameters:
Returns: ReactElement

display as a ReactElement the breadcrumbs. clickAction - what happens when a given breadcrumb is clicked. project - the model project.

sheetTreeMap : Map<string, SheetTree>
cfg : BreadcrumbConfig
positionSheetsInGrid : Map<string, SheetTree> -> (CSSGridPos * SheetTree) list
dispatch : Msg -> unit
Returns: ReactElement

makeGridFromSheetsWithPositions cfg dispatch posL

Full Usage: makeGridFromSheetsWithPositions cfg dispatch posL

Parameters:
Returns: ReactElement
cfg : BreadcrumbConfig
dispatch : Msg -> unit
posL : (CSSGridPos * SheetTree) list
Returns: ReactElement

maybeWarning dialogText project

Full Usage: maybeWarning dialogText project

Parameters:
    dialogText : string
    project : Project

Returns: ReactElement option

return a react warning message if name if not valid for a sheet Add or Rename, or else None

dialogText : string
project : Project
Returns: ReactElement option

pathsWithDependencies destProjectDir paths sourceProjectDir

Full Usage: pathsWithDependencies destProjectDir paths sourceProjectDir

Parameters:
    destProjectDir : string
    paths : string list
    sourceProjectDir : string

Returns: (string * Set<string>) list

Returns with a list of each path with its dependencies. This includes dependencies of dependencies

destProjectDir : string
paths : string list
sourceProjectDir : string
Returns: (string * Set<string>) list

positionDesignHierarchyInGrid rootSheet trees

Full Usage: positionDesignHierarchyInGrid rootSheet trees

Parameters:
Returns: (CSSGridPos * SheetTree) list
rootSheet : string
trees : Map<string, SheetTree>
Returns: (CSSGridPos * SheetTree) list

positionRootAndFocusChildrenInGrid root pathToFocus trees

Full Usage: positionRootAndFocusChildrenInGrid root pathToFocus trees

Parameters:
    root : string
    pathToFocus : string list
    trees : Map<string, SheetTree>

Returns: (CSSGridPos * SheetTree) list
root : string
pathToFocus : string list
trees : Map<string, SheetTree>
Returns: (CSSGridPos * SheetTree) list

renameSheetBeforeImportPopup oldPath model dispatch

Full Usage: renameSheetBeforeImportPopup oldPath model dispatch

Parameters:
    oldPath : string
    model : Model
    dispatch : Msg -> unit

When sheet selected for import is from current directory, show popup asking user to rename the file

oldPath : string
model : Model
dispatch : Msg -> unit

smallSimulationBreadcrumbs rootName pathToFocus cfg dispatch model

Full Usage: smallSimulationBreadcrumbs rootName pathToFocus cfg dispatch model

Parameters:
Returns: ReactElement

Breadcrumbs of the focus sheet, with sheets on its path to root, and its children. Provides navigation while occupying small vertical area. Untested. *** TODO: hookthis function to simulation and test *** Should be called extracting inputs from waveform simulation. Display as a ReactElement the breadcrumbs. clickAction - what happens when a given breadcrumb (labelled by its path to root) is clicked. project - the model project

rootName : string
pathToFocus : string list
cfg : BreadcrumbConfig
dispatch : Msg -> unit
model : Model
Returns: ReactElement

twoButtons leftButton rightButton

Full Usage: twoButtons leftButton rightButton

Parameters:
Returns: ReactElement

return react element for 2 buttons that are side by side

leftButton : ReactElement list
rightButton : ReactElement list
Returns: ReactElement

Type something to start searching.