Profile module documentation

Profile activity manipulation

resolveProfileResource :: Resource -> [String] -> <ReadGraph,Proc> Resource
resolveProfileResource runtimeProfile profileNamePath

Attempts to resolve the specified profile group name path starting from the specified runtime profile. If the path cannot be fully resolved, a RuntimeException will be thrown with a message detailing the child that could not be found.

A profileNamePath can have as many segments as needed to uniquely reference a profile group or entry in the inspected runtimeProfile's hierarchy.

A path could be for example:

["1st level profile name", "2nd level profile name"]
toggleProfileGroup :: Resource -> String -> Boolean -> <WriteGraph> ()
toggleProfileGroup runtimeProfile profileGroupName enabled

Toggles the given profileGroupOrEntryResource in given runtimeProfile on (True) or off (False) based on enabled.

toggleProfileByResource :: Boolean -> Resource -> Resource -> <WriteGraph> ()
toggleProfileByResource enabled runtimeProfile profileGroupOrEntryResource

Toggles the given profileGroupOrEntryResource in given runtimeProfile on (True) or off (False) based on enabled.

Use resolveProfileResource to find profile groups or entries.

activateProfileEntries :: Resource -> [Resource] -> <WriteGraph> ()
activateProfileEntries profile entries

Marks the specified profile entries as active for the specified profile.

Diagram element profile monitor stack manipulation

resetProfileMonitorPosition :: Resource -> <WriteGraph> ()
resetProfileMonitorPosition diagramElement

Resets the profile monitor stack position offset to (0,0) for the specified diagramElement.

setProfileMonitorPosition :: Resource -> Double -> Double -> <WriteGraph> ()
setProfileMonitorPosition diagramElement xOffset yOffset

Sets the profile monitor stack position offset to (xOffset, yOffset) for the specified diagramElement.

GrowUp :: ProfileMonitorStackGrowDirection
GrowDown :: ProfileMonitorStackGrowDirection
setProfileMonitorStackGrowDirection :: ProfileMonitorStackGrowDirection -> Resource -> <WriteGraph> ()

Set profile monitor stack growth direction for a single diagram element to the specified value (GrowUp | GrowDown)

Manual profile creation

createProfile :: String -> [Resource] -> <WriteGraph> Resource
createProfile profileName entries

Creates a profile with given name and entries and returns the created profile. This function does not attach the created profile to anything yet.

createProfileEntry :: String -> Resource -> Resource -> <WriteGraph> Resource
createProfileEntry name style group

Creates a profile entry with the specified name, style definition and group definition

createToplevelProfile :: Resource -> String -> [Resource] -> <WriteGraph> Resource
createToplevelProfile model name entries

Creates a top-level profile using createProfile, attaches it to the specified model and marks it as the active profile for the model.