Header menu logo Nu

Overlayer Module

Types

Type Description

Overlayer

Defines the manner in which overlays are applied to targets.

Functions and values

Function or value Description

Overlayer.applyOverlay copyTarget overlayNameOld overlayNameNew facetNames target overlayer

Full Usage: Overlayer.applyOverlay copyTarget overlayNameOld overlayNameNew facetNames target overlayer

Parameters:
    copyTarget : 'a -> 'a
    overlayNameOld : string
    overlayNameNew : string
    facetNames : string seq
    target : 'a
    overlayer : Overlayer

Returns: 'a

Apply an overlay to the given target (except for any FacetNames property). Only the properties that are overlaid by the old overlay will be changed.

copyTarget : 'a -> 'a
overlayNameOld : string
overlayNameNew : string
facetNames : string seq
target : 'a
overlayer : Overlayer
Returns: 'a

Overlayer.applyOverlay6 copyTarget overlayNameOld overlayNameNew facetNames target overlayerOld overlayerNew

Full Usage: Overlayer.applyOverlay6 copyTarget overlayNameOld overlayNameNew facetNames target overlayerOld overlayerNew

Parameters:
    copyTarget : 'a -> 'a
    overlayNameOld : string
    overlayNameNew : string
    facetNames : string seq
    target : 'a
    overlayerOld : Overlayer
    overlayerNew : Overlayer

Returns: 'a

Apply an overlay to the given target (except for any FacetNames property). Only the properties that are overlaid by the old overlay as specified by the old overlayer will be changed.

copyTarget : 'a -> 'a
overlayNameOld : string
overlayNameNew : string
facetNames : string seq
target : 'a
overlayerOld : Overlayer
overlayerNew : Overlayer
Returns: 'a

Overlayer.applyOverlayToFacetNames copyTarget overlayNameOld overlayNameNew target overlayerOld overlayerNew

Full Usage: Overlayer.applyOverlayToFacetNames copyTarget overlayNameOld overlayNameNew target overlayerOld overlayerNew

Parameters:
    copyTarget : 'a -> 'a
    overlayNameOld : string
    overlayNameNew : string
    target : 'a
    overlayerOld : Overlayer
    overlayerNew : Overlayer

Returns: 'a

Apply an overlay to the FacetNames property of the given target.

copyTarget : 'a -> 'a
overlayNameOld : string
overlayNameNew : string
target : 'a
overlayerOld : Overlayer
overlayerNew : Overlayer
Returns: 'a

Overlayer.empty

Full Usage: Overlayer.empty

Returns: Overlayer

The empty overlayer.

Returns: Overlayer

Overlayer.getExtrinsicOverlays overlayer

Full Usage: Overlayer.getExtrinsicOverlays overlayer

Parameters:
Returns: Overlay list

Get extrinsic overlays.

overlayer : Overlayer
Returns: Overlay list

Overlayer.getIntrinsicOverlays overlayer

Full Usage: Overlayer.getIntrinsicOverlays overlayer

Parameters:
Returns: Overlay list

Get intrinsic overlays.

overlayer : Overlayer
Returns: Overlay list

Overlayer.getOverlays overlayer

Full Usage: Overlayer.getOverlays overlayer

Parameters:
Returns: Map<string, Overlay>

Get overlays.

overlayer : Overlayer
Returns: Map<string, Overlay>

Overlayer.make intrinsicOverlays extrinsicOverlays

Full Usage: Overlayer.make intrinsicOverlays extrinsicOverlays

Parameters:
Returns: Overlayer

Make an overlayer.

intrinsicOverlays : Overlay list
extrinsicOverlays : Overlay list
Returns: Overlayer

Overlayer.makeFromFileOpt intrinsicOverlays filePath

Full Usage: Overlayer.makeFromFileOpt intrinsicOverlays filePath

Parameters:
    intrinsicOverlays : Overlay list
    filePath : string

Returns: Overlayer

Make an overlayer by attempting to load extrinsic overlays from a file and then combining it with the given intrinsic overlays.

intrinsicOverlays : Overlay list
filePath : string
Returns: Overlayer

Overlayer.tryGetOverlayNameOpt dispatcherName overlayRouter

Full Usage: Overlayer.tryGetOverlayNameOpt dispatcherName overlayRouter

Parameters:
    dispatcherName : string
    overlayRouter : Overlayer

Returns: string option

Try to find an optional overlay name for a given classification.

dispatcherName : string
overlayRouter : Overlayer
Returns: string option

Type something to start searching.