Graph

Methods

(static) addHighlight() → {Highlight}

Source:

• DCR.js, line 7124

Returns:

Type

Highlight

(static) addHighlightLayer() → {HighlightLayer}

Source:

• DCR.js, line 7166

Returns:

Type

HighlightLayer

(static) createConnection(from, to, type, guard, level, desc) → {object}

Source:

• DCR.js, line 3828

Example

var myApp = new DCR();
myApp.createEvent({'id':'Enter'});
myApp.createEvent({'id':'Exit'});
myApp.createConnection(myApp.getById('Enter'), myApp.getById('Exit'), 'response');
//this will create an Event Element Enter and Exit, then we can use the app to create a response connection between two by finding them by their Ids.

Parameters:

Returns:

Type

object

(static) createEvent(el) → {object}

Source:

• DCR.js, line 3732

Example

var myApp = new DCR();
myApp.createEvent(); //this will create a simple event
myApp.createEvent({'custom' : {'label':'An Event', 'eventDescription':'This is a test Event'}});
//we can also provide attributes for the event object like above

Parameters:

Returns:

Type

object

(static) createForm(el) → {object}

Source:

• DCR.js, line 3785

Example

var myApp = new DCR();
myApp.createForm(); //this will create a simple process
myApp.createForm({'custom' : {'label':'A Form', 'eventDescription':'This is a test Form'}});
//we can also provide attributes for the process object like above, most of the properties of events and processes are same so we can use the same properties here

Parameters:

Returns:

Type

object

(static) createFragment(el) → {object}

Source:

• DCR.js, line 3807

Example

var myApp = new DCR();
myApp.createFragment(); //this will create a simple process
myApp.createFragment({'custom' : {'label':'A Form', 'eventDescription':'This is a test Form'}});
//we can also provide attributes for the process object like above, most of the properties of events and processes are same so we can use the same properties here

Parameters:

Returns:

Type

object

(static) createProcess(el) → {object}

Source:

• DCR.js, line 3758

Example

var myApp = new DCR();
myApp.createProcess(); //this will create a simple process
myApp.createProcess({'custom' : {'label':'A Process', 'eventDescription':'This is a test Process'}});
//we can also provide attributes for the process object like above, most of the properties of events and processes are same so we can use the same properties here

Parameters:

Returns:

Type

object

(static) export() → {object}

Source:

• DCR.js, line 5748

Returns:

Type

object

(static) findActivity(id) → {object}

Source:

• DCR.js, line 3995

Example

var myApp = new DCR();
myApp.createEvent({'id':'An Event', 'custom' : {'label': 'test item'}});
myApp.findActivity('An Event');
//returns Element

Parameters:

Returns:

Type

object

(static) generateHighlightXML() → {string}

Source:

• DCR.js, line 7289

Example

<highlighterMarkup>
						<highlightLayers>
							<highlightLayer default="true" name="description">... highlight text here ...</highlightLayer>
						</highlightLayers>
						<highlights>
							... highlight xml here ...
						</highlights>
					</highlighterMarkup>

Returns:

Type

string

(static) getAllLevels() → {array}

Source:

• DCR.js, line 3898

Example

var myApp = new DCR();
myApp.createEvent({'custom' : {'label':'An Event', 'level':2}});
myApp.createEvent({'custom' : {'label':'Another Event', 'level':5}});
myApp.getAllLevels();
//returns [2, 5]

Returns:

Type

array

(static) getById(id) → {object}

Source:

• DCR.js, line 4023

Example

var myApp = new DCR();
myApp.createEvent({'id':'An Event', 'custom' : {'label': 'test item'}});
myApp.getById('An Event');
//returns Element

Parameters:

Returns:

Type

object

(static) getDefaultHighlightLayer() → {HighlightLayer}

Source:

• DCR.js, line 7181

Returns:

Type

HighlightLayer

(static) getEscapedHighlighterText() → {string}

Source:

• DCR.js, line 7369

Returns:

Type

string

(static) getEventsByLevel(sLevel, proToo) → {array}

Source:

• DCR.js, line 3943

Example

var myApp = new DCR();
myApp.createEvent({'custom' : {'label':'An Event', 'level':2}});
myApp.createEvent({'custom' : {'label':'Another Event','level':5}});
myApp.getEventsByLevel(5);
//returns [Element]

Parameters:

Returns:

Type

array

(static) getEventsByRole(sRole) → {array}

Source:

• DCR.js, line 3920

Example

var myApp = new DCR();
myApp.createEvent({'custom' : {'label':'An Event', 'roles':['test']}});
myApp.createEvent({'custom' : {'label':'Another Event','roles':['test']}});
myApp.getEventsByRole('test');
//returns [Element, Element]

Parameters:

Returns:

Type

array

(static) getHighlightByGUID(id) → {object}

Source:

• DCR.js, line 7337

Parameters:

Returns:

Type

object

(static) getHighlighterText(layer) → {string}

Source:

• DCR.js, line 7353

Parameters:

Returns:

Type

string

(static) getInterfaceEvents() → {array}

Source:

• DCR.js, line 3971

Example

var myApp = new DCR();
myApp.getInterfaceEvents({'interfaceEvent': true, 'custom' : {'label':'An Event', 'level':2}});
myApp.createEvent({'custom' : {'label':'Another Event','level':5}});
myApp.getInterfaceEvents();
//returns [Element]

Returns:

Type

array

(static) getMaxNLevel() → {Number}

Source:

• DCR.js, line 3864

Returns:

Type

Number

(static) getMaxSequence() → {Number}

Source:

• DCR.js, line 3881

Returns:

Type

Number

(static) import(graphXML, graphID, configs, options, callback) → {object}

Source:

• DCR.js, line 5693

Parameters:

Returns:

Type

object

(static) intializeGraphXml(graphXml, callback) → {object}

Source:

• DCR.js, line 5296

Example

var myApp = new DCR();
myApp.intializeGraphXml(xml);
//if the request is made successful then this will load the graph ready to be used

Parameters:

Returns:

Type

object

(static) loadGraph(graphId, callback) → {object}

Source:

• DCR.js, line 5247

Example

var myApp = new DCR();
myApp.loadGraph(2275);
//if the request is made successful then this will load the graph ready to be used

Parameters:

Returns:

Type

object

(static) loadXML(graphXML) → {object}

Source:

• DCR.js, line 5345

Parameters:

Returns:

Type

object

(static) loadXMLString(graphXML) → {object}

Source:

• DCR.js, line 5785

Example

<!doctype html>
	<html>
	<head>
	    <meta charset="utf-8">
	    <title>Demo App</title>
	</head>
	<body>
	    <script src="jquery.js"></script>
	    <script src="xml2json.js"></script>
	    <script src="DCR.js"></script>	
	    <script>
		$(document).ready(function () {
	 		var myApp = new DCR();
			
			$('#loadGraph').on('click', function () {
				var fileXML = $('#xmlInput').val();
				if(fileXML==" " || fileXML == ""){
					alert('Invalid Input');
					return;
				}
				myApp.loadXMLString(fileXML);
				//graph will reset first by default by this function just in case user clicks several time
				//so each time new graph is to be laoded properly
			});
	    })
	 
	    </script>
		<textarea id="xmlInput"></textarea>
		<input type="submit" id="loadGraph" value="Load DCR Graph" />
	</body>
	</html>

Parameters:

Returns:

Type

object

(static) printXML() → {object}

Source:

• DCR.js, line 7099

Example

var myApp = new DCR();
myApp.loadGraph(2275);
myApp.printXML();
//we can get the latest XML of the graph through the above command

Returns:

Type

object

(static) removeHighlightsOf(item)

Source:

• DCR.js, line 7325

Parameters:

(static) reset() → {object}

Source:

• DCR.js, line 3423

Example

var myApp = new DCR();
myApp.createEvent(); //An Event will be added to the graph.
myApp.reset(); // will reset the graph.

Returns:

Type

object

(static) setupHighlighterMarkup(textContainerId)

Source:

• DCR.js, line 7515

Parameters:

(static) updateMarkup(textContainerId)

Source:

• DCR.js, line 7525

Parameters:

(static) writeXML() → {object}

Source:

• DCR.js, line 7001

Example

var myApp = new DCR();
myApp.loadGraph(2275);
myApp.createEvent({'custom' : {'label':'An Event'}});
myApp.writeXML();
//we can get the latest XML of the graph through the above command

Returns:

Type

object