OTRS API Reference JavaScript

Namespace: Core.Agent.Admin.ProcessManagement.Canvas

Core.Agent.Admin.ProcessManagement. Canvas

This namespace contains the special module functions for the ProcessManagement Diagram Canvas module.
Author:
  • OTRS AG
Source:

Members

(static) LastTransitionDetails :Object

Structure to save last transition to restore correctly after repaint.
Type:
  • Object
Source:

Methods

(static) CreateActivity(EntityID, EntityName, ActivityID, PosX, PosY)

Create activity at specific position.
Parameters:
Name Type Description
EntityID String
EntityName String
ActivityID String
PosX String
PosY String
Source:

(static) CreateActivityDummy(StartActivityID)

Create a dummy activity.
Parameters:
Name Type Description
StartActivityID String
Source:

(static) CreateStartEvent(PosX, PosY)

Create the initial start event at a specific position.
Parameters:
Name Type Description
PosX String
PosY String
Source:

(static) CreateTransition(StartElement, EndElement, EntityID, TransitionName) → {Boolean}

Create new transition between StartElement and EndElement.
Parameters:
Name Type Description
StartElement String
EndElement String
EntityID String
TransitionName String
Source:
Returns:
Returns fale, if start activity or end activity is not defined.
Type
Boolean

(static) DrawDiagram()

Draws the diagram on the canvas.
Source:

(static) Extend(CanvasSize)

Extends the canvas size.
Parameters:
Name Type Description
CanvasSize Object
Source:

(static) HighlightTransitionLabel(Connection, StartActivity, EndActivity)

Highlight transition label.
Parameters:
Name Type Description
Connection String
StartActivity String
EndActivity String
Source:

(static) Init()

Initialize module functionality.
Source:

(static) MakeDraggable()

Makes all activities draggable.
Source:

(static) Redraw()

Redraws diagram.
Source:

(static) RemoveActivity(EntityID)

Remove activity from canvas an data structures.
Parameters:
Name Type Description
EntityID String
Source:

(static) RemoveActivityFromConfig(EntityID)

Remove activity from config.
Parameters:
Name Type Description
EntityID String
Source:

(static) SetStartActivity(EntityID)

Set start activity and add connection to it from start event.
Parameters:
Name Type Description
EntityID String
Source:

(static) ShowActivityAddActivityDialogError(EntityID)

Remove loader on activity on error.
Parameters:
Name Type Description
EntityID String
Source:

(static) ShowActivityAddActivityDialogSuccess(EntityID)

Show success icon on activity (and fade out again after 1 second).
Parameters:
Name Type Description
EntityID String
Source:

(static) ShowActivityDeleteButton($Element) → {Boolean}

Show button to delete an activity.
Parameters:
Name Type Description
$Element jQueryObject
Source:
Returns:
Returns false, if activity is not defined.
Type
Boolean

(static) ShowActivityEditButton($Element) → {Boolean}

Show button to edit an activity.
Parameters:
Name Type Description
$Element jQueryObject
Source:
Returns:
Returns false, if activity is not defined.
Type
Boolean

(static) ShowActivityLoader(EntityID)

Show loader on activity element.
Parameters:
Name Type Description
EntityID String
Source:

(static) ShowActivityTooltip($Element) → {Boolean}

Show tooltip of an activity.
Parameters:
Name Type Description
$Element jQueryObject
Source:
Returns:
Returns false, if activity is not defined.
Type
Boolean

(static) ShowEntityIDs()

Shows EntityIDs on every element for debugging.
Source:

(static) ShowTransitionTooltip(Connection, StartActivity) → {Boolean}

Show tooltip of a transition.
Parameters:
Name Type Description
Connection Object
StartActivity String
Source:
Returns:
Returns false, if transition is not defined.
Type
Boolean

(static) UnHighlightTransitionLabel(Connection)

Unhighlight transition label.
Parameters:
Name Type Description
Connection String
Source:

(static) UpdateElementPosition($Element)

Update position of element in layout data structure.
Parameters:
Name Type Description
$Element jQueryObject
Source: