OTRS API Reference JavaScript

Members

(static) LastSequenceFlowDetails :Object

Structure to save last sequence flow to restore correctly after repaint.

Type:

• Object

Methods

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

Create activity at specific position.

Parameters:

Name	Type	Description
EntityID	String
EntityName	String
ActivityID	String
PosX	String
PosY	String
ActivityType	String

(static) CreateActivityDummy(StartActivityID)

Create a dummy activity.

Parameters:

Name	Type	Description
StartActivityID	String

(static) CreateSequenceFlow(StartElement, EndElement, EntityID, SequenceFlowName) → {Boolean}

Create new sequence flow between StartElement and EndElement.

Parameters:

Name	Type	Description
StartElement	String
EndElement	String
EntityID	String
SequenceFlowName	String

Returns:

Returns fale, if start activity or end activity is not defined.

Type

Boolean

(static) CreateStartEvent(PosX, PosY)

Create the initial start event at a specific position.

Parameters:

Name	Type	Description
PosX	String
PosY	String

(static) DrawDiagram()

Draws the diagram on the canvas.

(static) Extend(CanvasSize)

Extends the canvas size.

Parameters:

Name	Type	Description
CanvasSize	Object

(static) HighlightSequenceFlowLabel(Connection, StartActivity, EndActivity)

Highlight sequence flow label.

Parameters:

Name	Type	Description
Connection	String
StartActivity	String
EndActivity	String

(static) Init()

Initialize module functionality.

(static) MakeDraggable()

Makes all activities draggable.

(static) Redraw()

Redraws diagram.

(static) RemoveActivity(EntityID)

Remove activity from canvas an data structures.

Parameters:

Name	Type	Description
EntityID	String

(static) RemoveActivityFromConfig(EntityID)

Remove activity from config.

Parameters:

Name	Type	Description
EntityID	String

(static) SetStartActivity(EntityID)

Set start activity and add connection to it from start event.

Parameters:

Name	Type	Description
EntityID	String

(static) ShowActivityAddActivityDialogError(EntityID)

Remove loader on activity on error.

Parameters:

Name	Type	Description
EntityID	String

(static) ShowActivityAddActivityDialogSuccess(EntityID)

Show success icon on activity (and fade out again after 1 second).

Parameters:

Name	Type	Description
EntityID	String

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

Show button to delete an activity.

Parameters:

Name	Type	Description
$Element	jQueryObject

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

Returns:

Returns false, if activity is not defined.

Type

Boolean

(static) ShowActivityLoader(EntityID)

Show loader on activity element.

Parameters:

Name	Type	Description
EntityID	String

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

Show tooltip of an activity.

Parameters:

Name	Type	Description
$Element	jQueryObject

Returns:

Returns false, if activity is not defined.

Type

Boolean

(static) ShowEntityIDs()

Shows EntityIDs on every element for debugging.

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

Show tooltip of a sequence flow.

Parameters:

Name	Type	Description
Connection	Object
StartActivity	String

Returns:

Returns false, if sequence flow is not defined.

Type

Boolean

(static) UnHighlightSequenceFlowLabel(Connection)

Unhighlight sequence flow label.

Parameters:

Name	Type	Description
Connection	String

(static) UpdateElementPosition($Element)

Update position of element in layout data structure.

Parameters:

Name	Type	Description
$Element	jQueryObject