Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

Collection Template

removeArcs()

Bulk mechanism to remove all arcs that match a specified set of criteria.

Syntax

number = rb.collection.removeArcs(searchParams)

Parameters

The 'removeArcs' method takes 1 parameter:

Name Type/Value Range/Length Description
searchParamsstruct arcSearchTypesee definition Required. Structure defining which arcs are to be deleted

Results

The 'removeArcs' method returns number:

Type/Value Range/Length Description
number  

Remarks

Individual relationships (arcs) can be deleted using rb.collection.configureArcs method. There are however times when it's useful to remove a whole range of relations quickly and efficiently.

This (removeArcs) method uses the same search specification structure as rb.collection.getArcs, although not all the fields are used.

Use this method with care! It is quite easy to remove a whole raft of relations with this method - make sure you have the search specification right!

The search structure ( arcSearchType) has the following restrictions when used in this method:

  • startPointType/startPointID - must be specified and must exist
  • allData - Not used
  • sortBy - Not used
Whitebeam release 1.3.36
(loadtime : 68ms)