Diagram
Tag Attributes
<ss:data:diagram />
Type=""
Type of the diagram
Currently supported: Org
disablecontextmenu=""
Disable Context Menu.
Set this to true you want right-click handlers to work properly
Positioning=""
Diagram Positioning
OrgContactWidth=""
Org Diagram Contact Box Width
OrgContactHeight=""
Org Diagram Contact Box Height
OrgContactPadding=""
Org Diagram Contact Padding
OrgContactDisplayName=""
Org Diagram Display Name Field
In the jointjs library, this field is displayed at the bottom
OrgContactDisplayPosition=""
Org Diagram Display Position Field
In the jointjs library, this field is displayed at the top
DataSourceSupportsPaging=""
Sets whether the DataSource supports the paging parameters
When set to true, two parameters will be appended to the call to the DataSource which
represent the start and limit values of pagination
DataSourceSupportsOrdering=""
Sets whether the DataSource supports the order parameter
When set to true, an order parameter will be appended to the data. The order parameter
is an array containing values similar to: array(array('contact_id', 'desc'), ...)
DataJoins=""
Data joins
DataFilter=""
Data filter
DataSearch=""
Data Search
DataStart=""
Data start
DataLimit=""
Data limit
DataGroupBy=""
Data Group By
PopulateAt=""
Sets when to populate from the datasource
KeyAs=""
The name of the variable to be registered for each row's key
Paging=""
Whether to enable paging on the data control
PagingRows=""
Number of rows to show before paging
PagingAutoRender=""
If set to false, you must call $element.renderPagerControl() manually
EmptyMessage=""
The message shown when there are no rows in the data control
ClassRow=""
The CSS class for rows (<tr> tags)
Exportable=""
Whether or not to add an export link
UseAjax=""
Whether or not to enhance the control using AJAX
DataSource=""
Sets the data source for retreiving the result set
DataOrder=""
Sets the order by which the data is sorted
The parameter is a two dimensional array consisting of column names and the
direction of the order.
For example, the following would sort contacts by their last name ascending and in the
event of two contacts having the same last name, their first name descending
array(array('contact_last_name', 'asc'), array('contact_first_name', 'desc'))
As=""
Sets the name of the variable registered for each row
HasPopulated=""
Returns whether or not the data control has been populated
CurrentRowId=""
Returns the current row id
Width=""
Sets the width of the element
Height=""
Sets the height of the element
Id=""
Sets id of the object - used for the html id attribute and referencing in the parser's
document object model
AttributeSet=""
Calls setAttribute() for each key value pair in $arrAttributes
AjaxModified=""
Sets whether or not this object is modified by ajax requests
AjaxEventParameter=""
Sets a parameter which can be passed to the ajax event
Be careful with security on this parameter as it is passed through javascript in the
clients browser.
ChildNodes=""
Sets the children of this node in the DOM
InnerText=""
Adds a new TextNode child at the end of the children
Class Methods
The following methods can be invoked on instances of this class.
Handler for Org Diagrams
Fix contact coordinates so that they are all positive and determine the <svg> canvas size
Returns a definition of the spatial quadrants for auto positioning purposes
In order to auto position, some parameters are necessary:
- contacts: id, type
- joints: id, reciprocal
Adds JS events on an Org Diagram contacts & joints
Sets the data source for retreiving the result set
Returns the current data source
Sets the order by which the data is sorted
The parameter is a two dimensional array consisting of column names and the
direction of the order.
For example, the following would sort contacts by their last name ascending and in the
event of two contacts having the same last name, their first name descending
array(array('contact_last_name', 'asc'), array('contact_first_name', 'desc'))
Returns the order by which data is sorted
Sets the name of the variable registered for each row
Sets the name of the variable registered for each row
Restores the saved state of this object from the users session
Returns a list of properties which will be saved to session state
Returns whether or not the data control has been populated
Returns the current row id
Sets the data (usually done by populate())
Returns the data that was returned by populating from the datasource
Returns the number of rows returned by the datasource
Sets the parser variables for As="" and KeyAs=""
Removes the parser variables for As="" and KeyAs=""
Adds rows from the configured datasource
Executes the datasource expression
Repopulates the data control
Note: There should not ever be a need to call this function.
AJAX calls repopulate data controls automaticallly.
Renders the message to be displayed when no rows are present
Renders a data row
Other data controls override this to render rows in different ways.
Renders the pager arrows / comboboxes at the bottom of the data control
Returns the base tag name
Returns whether the tag is closed inline
Sets the width of the element
Returns the width of the element
Sets the height of the element
Returns the height of the element
Returns a set of JavaScript attributes that differ from the default JS implementation
Default values on properties can be specified by @js_attribute and @js_default
Returns the attributes of the elment as a renderable properties string
Generates an id for the node if one isnt already set
Returns whether or not this control will be wrapped in a container span
Restores a control from its element state
Sets id of the object - used for the html id attribute and referencing in the parser's
document object model
Returns the id of the object
Overload for returning an attribute
Overload for setting an attribute
Returns whether an attribute exists
Removes an attribute
Sets an attribute
Returns true when handled
Returns false when set as standard a HTML attribute
Calls setAttribute() for each key value pair in $arrAttributes
Sets generic HTML attributes not specified by attributes of this control
Returns the current attributes set that aren't defined attributes of this control
Sets a single attribute
Returns a single attribute
Adds a javascript handler attribute
If a handlers already exist, the new handler added to the end
Returns the value of the given attribute
Removes an attribute
Returns the objects attributes as an associative array
Merges two sets of attributes
Sets whether or not this object is modified by ajax requests
Returns whether or not this object is modified by ajax requests
Returns a list of all attributes to save to session state
Serializes the state of the object to session
Sets a key value pair for saving additional state data
This data is handled manually by each inheriting control
Returns whether an additional state key has been set
Returns the value of a key in the additional state set
Note: This function returns a reference
Deletes additional saved data
Sets an inner array key value pair for saving additional state data
Returns whether an additional state key has been set
Returns an inner array key value pair for additional state data
Returns the state data for the current object
Adds an event handler
If $strCode is an array, call_user_func_array will be called directly
call_user_func_array($strFunc[0], $strFunc[1]);
Triggers a server side event
Calls all event handlers set by addEventHandler
Sets the ajax event handlers
Adds an AJAX event handler
Sets the ajax event handlers
Sets a parameter which can be passed to the ajax event
Be careful with security on this parameter as it is passed through javascript in the
clients browser.
Returns the current ajax event parameter
Trigger an event by evaluating the script in $strFunc
Renders the element
Magic function for a better var_export() of nodes
Wake up
Renders the element to a string
Returns whether the control should trim its contents for optimisation purposes
Sets the elements parent node in the DOM
Returns the elements parent node in the DOM
Returns the first ascendant node of a specific class
Returns the elements top most / document element
Sets the children of this node in the DOM
Returns the children of this node
Adds new child at the end of the children
Adds a new TextNode child at the end of the children
Removes the specified node from the list of children
Resets the indicators for dom states so that reinitialisation / rendering can occur
Returns an array containing the states of parent controls
such as DialogBox and TabList
Magic function to trap calls to undefined functions and throw an exception rather than
a fatal error.
Magic function to trap static calls to undefined functions and throw an exception rather
than a fatal error.
Returns the folder where the class exists
Returns the folder where the class's resources exist
Returns the folder where the class exists
Returns the folder where the class exists
Returns the reflection data for the current class
Returns a specific class annotation for the current class