publish
IT2BE Gantt Bean


Servoy Properties Summary
Number annotationAlignment
String annotationColor
String annotationField
Boolean antiAlias
String bgcolor
Boolean dataEditingEnabled
String dateLineColor
String dateScaleHeaderColor
Boolean editLinksEnabled
Boolean editNewLinkEnabled
Boolean editNewNodeEnabled
Boolean editNodesEnabled
String fgcolor
Number ganttGrid
String gridColor
String groupBy
Number groupRowLayout
Boolean groupUpdateSummaries
String hierarchyNodeColor
Number histogramEndYValue
String infoWindowDateFormat
String infoWindowDecimalFormat
Array<String> infoWindowLabels
Boolean interactionDragEnabled
Number leftAnnotationAlignment
String leftAnnotationColor
String leftAnnotationField
Number nodeColorTransparancy
Number nodeMagnet
Number nodeMoveMode
Number nodeResizeMode
Boolean popupEnabled
String primaryNodeColor
String progressColor
Number rightAnnotationAlignment
String rightAnnotationColor
String rightAnnotationField
String rowEvenColor
String rowGroupColor
Number rowHeight
String rowOddColor
String secondaryNodeColor
Boolean show1To1Button
Boolean showButtonBar
Boolean showCreateLinkButton
Object showDateLine
Boolean showDateLineButton
Boolean showDeleteLinkButton
Boolean showDiagramButton
Boolean showFileSaveButton
Boolean showHistogramButton
Boolean showLeftRowHeaderButton
Boolean showLeftTableButton
Boolean showLowerTimescale
Boolean showLowerTimescaleButton
Boolean showNodeProgress
Boolean showPageFormatButton
Boolean showPanesButton
Boolean showPreviewButton
Boolean showPrintButton
Boolean showScaleFactorComboBox
Boolean showUpperTimescale
Boolean showUpperTimescaleButton
Boolean showZoomInButton
Boolean showZoomOutButton
Boolean showZoomRubberRectButton
Number tableColumnWidth
Boolean tableEditable
String tableHeaderColor
Number tableHierarchyColumnIndent
String tableLeafBgColor
String tableNonLeafBgColor
String tableRowHeaderColor
Boolean tableVisible
Number tableWidthPercentage
String timeScaleHeaderColor
Boolean timeScalePopupEnabled
Number timeScaleResolution
String timeScaleType
Boolean timescaleDynamicResolution
Boolean transparent
Boolean visible


Methods Summary
void addPopupAction( IGUserAction )
void addPopupSeparator( )
void addToolbarButton( IGUserAction )
void addToolbarToggleButton( IGUserAction )
void clearPopupActions( )
void connectNorthBean( IGanttComponent )
void connectSouthBean( IGanttComponent )
IGUserAction createUserAction( String, String, Object, Function, Array<String> )
void enablePopupAction( String, Boolean )
void enableToolbarButton( String, Boolean )
void expandGroupByNodeId( Object, Boolean )
void expandNodeById( Object, Boolean )
Array<String> getCenterRibbonTimescaleDateFormats( )
Number getDateLineDelay( )
Number getHeight( )
Number getLocationX( )
Number getLocationY( )
Array<String> getLowerRibbonTimescaleDateFormats( )
String getName( )
Array<String> getPopupActions( )
Array<String> getUpperRibbonTimescaleDateFormats( )
Number getWidth( )
void initialize( )
Boolean isShowOptionsButton( )
void refresh( )
void removeAllLinks( )
void removeAllNodes( )
void removeLinksById( Array<Object> )
void removeNodesById( Array<Object> )
void removePopupAction( String )
void removeToolbarButton( String )
void scrollToNodeWithId( Object )
void selectLinksById( Array<Object>, Boolean )
void selectLinksById( Array<Object> )
void selectNodesById( Array<Object>, Boolean )
void selectNodesById( Array<Object> )
void setAnnotation( IGAnnotation )
void setDateRange( Date, Date )
void setDateRangeChangedMethod( Function )
void setDynamicNodeColors( String, Array<Object> )
void setGanttFont( String )
void setGroupsDataSet( JSDataSet, Array<String> )
void setInfoWindowLabel( Number, String )
void setLinkChangedMethod( Function, Boolean )
void setLinkChangedMethod( Function )
void setLinkCreatedMethod( Function )
void setLinkDeletedMethod( Function )
void setLinkDraggedMethod( Function )
void setLinkRecords( JSDataSet )
void setLinkSelectedMethod( Function )
void setLinkWillChangeMethod( Function )
void setLinkWillChangeMethod( Function, Boolean )
void setLinkWillCreateMethod( Function )
void setLinkWillDeleteMethod( Function )
void setLinksDataSet( JSDataSet, Array<String> )
void setLocation( Number, Number )
void setMousePressedMethod( Function )
void setNodeChangedMethod( Function )
void setNodeChangedMethod( Function, Boolean )
void setNodeCreatedMethod( Function )
void setNodeDateColumns( String, String )
void setNodeDeletedMethod( Function )
void setNodeDraggedMethod( Function )
void setNodeIdColumns( Array<String> )
void setNodeProgressColumn( String )
void setNodeRecords( JSDataSet )
void setNodeSelectedMethod( Function )
void setNodeTooltipMethod( Function )
void setNodeWillChangeMethod( Function )
void setNodeWillChangeMethod( Function, Boolean )
void setNodeWillCreateMethod( Function )
void setNodeWillDeleteMethod( Function )
void setNodesDataSet( JSDataSet, Array<Object>, String )
void setNodesDataSet( JSDataSet )
void setNodesDataSet( JSDataSet, Array<Object> )
void setOnDataChangedMethod( Function )
void setScaleFactor( Number )
void setScheduler( IGScheduler )
void setShowFocus( Boolean )
void setShowHistogram( String, String )
void setSize( Number, Number )
void setTable( Array<Object> )
void setTable( Array<Object>, String, Number )
void setTable( Array<Object>, String )
void setTableHeaderFont( String )
void setTimeScaleCollapseDisplayMode( Number )
void setTimeScaleCollapseDisplayMode( Number, Number )
void setTimeScaleFont( String )
void setTimeScaleRibbonsDateFormats( Array<String>, Array<String>, Array<String> )
void setTimeSpan( Object )


Servoy Properties Details


annotationAlignment
Number  annotationAlignment
Get/Set the text alignment (when progress is set this is always left).
Returns
Number  alignment int

Supported Clients
SmartClient


annotationColor
String  annotationColor
Get/Set the text color for the annotation of the Node body.
Returns
String  color String

Supported Clients
SmartClient


annotationField
String  annotationField
Get/Set the annotation field for the Node body.
Returns
String  field String

Supported Clients
SmartClient


antiAlias
Boolean  antiAlias
Get/Set anti alias for the Bean.
Returns
Boolean  result boolean

Supported Clients
SmartClient


bgcolor
String  bgcolor
Get/Set the background color.
Returns
String  color String

Supported Clients
SmartClient


dataEditingEnabled
Boolean  dataEditingEnabled
Get/Set dataEditingEnabled to enable all data editing/creating.
Returns
Boolean  boolean

Supported Clients
SmartClient


dateLineColor
String  dateLineColor
Get/Set the color of the dateline.
Returns
String  color String

Supported Clients
SmartClient


dateScaleHeaderColor
String  dateScaleHeaderColor
Set the diagram datescale header color.
Returns
String  color String

Supported Clients
SmartClient


editLinksEnabled
Boolean  editLinksEnabled
Get/Set editLinksEnabled to enable editing links.
Returns
Boolean  result boolean

Supported Clients
SmartClient


editNewLinkEnabled
Boolean  editNewLinkEnabled
Get/Set editNewLinkEnabled to enable creating new links.
Returns
Boolean  result boolean

Supported Clients
SmartClient


editNewNodeEnabled
Boolean  editNewNodeEnabled
Get/Set editNewNodeEnabled to enable creating new nodes.
Returns
Boolean  result boolean

Supported Clients
SmartClient


editNodesEnabled
Boolean  editNodesEnabled
Get/Set editNodesEnabled to enable editing nodes.
Returns
Boolean  enabled boolean

Supported Clients
SmartClient


fgcolor
String  fgcolor
Get/Set the foreground color.
Returns
String  color String

Supported Clients
SmartClient


ganttGrid
Number  ganttGrid
Get/Set the type type (use the types in plugins.it2be_gantt).
Returns
Number  type int

Supported Clients
SmartClient


gridColor
String  gridColor
Get/Set the color of the grid.
Returns
String  color String

Supported Clients
SmartClient


groupBy
String  groupBy
Get/Set the column name to group the nodes by.
Returns
String  column String

Supported Clients
SmartClient


groupRowLayout
Number  groupRowLayout
Get/Set the layout of the group row (multiple rows, single row (with overlap) or single row optimized (no overlap).
Returns
Number  layout int

Supported Clients
SmartClient


groupUpdateSummaries
Boolean  groupUpdateSummaries
When groups data are defined this property can be used to update summeries based on node start- and end date changes.
Returns
Boolean  result boolean

Supported Clients
SmartClient


hierarchyNodeColor
String  hierarchyNodeColor
Get/Set the hierarchy color of the index nodes.
Returns
String  color String

Supported Clients
SmartClient


histogramEndYValue
Number  histogramEndYValue
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Number  y double

Supported Clients
SmartClient


infoWindowDateFormat
String  infoWindowDateFormat
Get/Set the date format for dates in the infoWindow (shown when moving nodes).
Returns
String  format String

Supported Clients
SmartClient


infoWindowDecimalFormat
String  infoWindowDecimalFormat
Get/Set the decimal format for decimal numbers in the infoWindow (shown when moving nodes).
Returns
String  format String

Supported Clients
SmartClient


infoWindowLabels
Array<String>  infoWindowLabels
Get/Set the label names (titles) in the infoWindow (shown when moving nodes).
Returns
Array<String>  labels String[]

Supported Clients
SmartClient


interactionDragEnabled
Boolean  interactionDragEnabled
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  enabled boolean

Supported Clients
SmartClient


leftAnnotationAlignment
Number  leftAnnotationAlignment
Get/Set the text alignment for the left annotation of the Node.
Returns
Number  alignment int

Supported Clients
SmartClient


leftAnnotationColor
String  leftAnnotationColor
Get/Set the text color for the left annotation of the Node.
Returns
String  color String

Supported Clients
SmartClient


leftAnnotationField
String  leftAnnotationField
Get/Set the annotation field for the left annotation of the Node.
Returns
String  field String

Supported Clients
SmartClient


nodeColorTransparancy
Number  nodeColorTransparancy
Get/Set the transparancy for all nodes (values between 128-255).
Returns
Number  transparancy int

Supported Clients
SmartClient


nodeMagnet
Number  nodeMagnet
Get/Set the time in minutes by which a dragged node should be increased/decreased.
Returns
Number  magnet int

Supported Clients
SmartClient


nodeMoveMode
Number  nodeMoveMode
Get/Set nodeMoveMode to set node move mode (constants can be found in Plug-in).
Returns
Number  mode int

Supported Clients
SmartClient


nodeResizeMode
Number  nodeResizeMode
Get/Set nodeResizeMode to set node resize mode (constants can be found in Plug-in).
Returns
Number  mode int

Supported Clients
SmartClient


popupEnabled
Boolean  popupEnabled
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  enabled boolean

Supported Clients
SmartClient


primaryNodeColor
String  primaryNodeColor
Get/Set the primary color of the nodes.
Returns
String  color String

Supported Clients
SmartClient


progressColor
String  progressColor
Get/Set the color of the progress bar in nodes.
Returns
String  color String

Supported Clients
SmartClient

Sample
// Get/Set the color of the progress bar in nodes.
// column values should be integer values between 0 and 100
elements.it2be_gantt.setNodeProgressColumn("progress");
elements.it2be_gantt.progressColor = "FFAAGG";
elements.it2be_gantt.showNodeProgress = true;

elements.it2be_gantt.refresh();


rightAnnotationAlignment
Number  rightAnnotationAlignment
Get/Set the text alignment for the right annotation of the Node.
Returns
Number  alignment int

Supported Clients
SmartClient


rightAnnotationColor
String  rightAnnotationColor
Get/Set the text color for the right annotation of the Node.
Returns
String  color String

Supported Clients
SmartClient


rightAnnotationField
String  rightAnnotationField
Get/Set the annotation field for the right annotation of the Node.
Returns
String  field String

Supported Clients
SmartClient


rowEvenColor
String  rowEvenColor
Get/Set the background color for all even rows.
Returns
String  color String

Supported Clients
SmartClient


rowGroupColor
String  rowGroupColor
Get/Set the background color for all group index rows.
Returns
String  color String

Supported Clients
SmartClient


rowHeight
Number  rowHeight
This property sets or retrieves the height of a layer. Unit: 1/100 mm. (minimum 320)
Returns
Number  height int

Supported Clients
SmartClient


rowOddColor
String  rowOddColor
Get/Set the background color for all odd rows.
Returns
String  color String

Supported Clients
SmartClient


secondaryNodeColor
String  secondaryNodeColor
Get/Set the secondary color of the nodes to create 3d effect.
Returns
String  color String

Supported Clients
SmartClient


show1To1Button
Boolean  show1To1Button
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showButtonBar
Boolean  showButtonBar
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showCreateLinkButton
Boolean  showCreateLinkButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showDateLine
Object  showDateLine
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Object  result Object

Supported Clients
SmartClient


showDateLineButton
Boolean  showDateLineButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showDeleteLinkButton
Boolean  showDeleteLinkButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showDiagramButton
Boolean  showDiagramButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showFileSaveButton
Boolean  showFileSaveButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showHistogramButton
Boolean  showHistogramButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showLeftRowHeaderButton
Boolean  showLeftRowHeaderButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showLeftTableButton
Boolean  showLeftTableButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showLowerTimescale
Boolean  showLowerTimescale
Show the lower timescale.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showLowerTimescaleButton
Boolean  showLowerTimescaleButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showNodeProgress
Boolean  showNodeProgress
Get/Set the visibility of the progress bar in nodes.
Returns
Boolean  result boolean

Supported Clients
SmartClient

Sample
// Get/Set the visibility of the progress bar in nodes.
// column values should be integer values between 0 and 100
elements.it2be_gantt.setNodeProgressColumn("progress");
elements.it2be_gantt.progressColor = "FFAAGG";
elements.it2be_gantt.showNodeProgress = true;

elements.it2be_gantt.refresh();


showPageFormatButton
Boolean  showPageFormatButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showPanesButton
Boolean  showPanesButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showPreviewButton
Boolean  showPreviewButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showPrintButton
Boolean  showPrintButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showScaleFactorComboBox
Boolean  showScaleFactorComboBox
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showUpperTimescale
Boolean  showUpperTimescale
Show the upper timescale.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showUpperTimescaleButton
Boolean  showUpperTimescaleButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showZoomInButton
Boolean  showZoomInButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showZoomOutButton
Boolean  showZoomOutButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


showZoomRubberRectButton
Boolean  showZoomRubberRectButton
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


tableColumnWidth
Number  tableColumnWidth
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Number  width double

Supported Clients
SmartClient


tableEditable
Boolean  tableEditable
Enable editing of data direct in the table rows.
Returns
Boolean  editable boolean

Supported Clients
SmartClient


tableHeaderColor
String  tableHeaderColor
Get/Set the color of the table header.
Returns
String  color String

Supported Clients
SmartClient


tableHierarchyColumnIndent
Number  tableHierarchyColumnIndent
Get/Set the indentation in mm for the hierarchy column.
Returns
Number  indentation int

Supported Clients
SmartClient


tableLeafBgColor
String  tableLeafBgColor
Get/Set the color of the table leaf node.
Returns
String  color String

Supported Clients
SmartClient


tableNonLeafBgColor
String  tableNonLeafBgColor
Get/Set the color of the table non leaf node.
Returns
String  color String

Supported Clients
SmartClient


tableRowHeaderColor
String  tableRowHeaderColor
Get/Set the color of the table row header.
Returns
String  color String

Supported Clients
SmartClient


tableVisible
Boolean  tableVisible
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  visible boolean

Supported Clients
SmartClient


tableWidthPercentage
Number  tableWidthPercentage
Get/Set the width of the table in percentage (1 = 100%) of the with of the bean.
Returns
Number  percentage double

Supported Clients
SmartClient


timeScaleHeaderColor
String  timeScaleHeaderColor
Get/Set diagram timeScale header color.
Returns
String  color String

Supported Clients
SmartClient


timeScalePopupEnabled
Boolean  timeScalePopupEnabled
Enable/disable the TimeScale popup .
Returns
Boolean  enabled boolean

Supported Clients
SmartClient


timeScaleResolution
Number  timeScaleResolution
Get/Set the width of the time units in the diagram (<= 1 is auto size).
Returns
Number  units int

Supported Clients
SmartClient


timeScaleType
String  timeScaleType
Get/Set the timescale type (use the types in plugins.it2be_gantt).
Returns
String  type String

Supported Clients
SmartClient


timescaleDynamicResolution
Boolean  timescaleDynamicResolution
Set the timescale to show in dynamic resolution (based on size).
Returns
Boolean  result boolean

Supported Clients
SmartClient


transparent
Boolean  transparent
Get/Set the transparency
Returns
Boolean  tranparent boolean

Supported Clients
SmartClient


visible
Boolean  visible
Get/Set the visibility
Returns
Boolean  visible oolean

Supported Clients
SmartClient

Methods Details


addPopupAction
void  addPopupAction( IGUserAction )
Add an action to the popup menu.
Parameters
IGUserAction  userAction  the user action

Returns
void  

Supported Clients
SmartClient

Sample
// AFTER initializing the bean you can start adding actions to the popup menu
// The way to do this is to create a user action first
var userAction = elements.it2be_gantt.createUserAction("action 1", "action 1", null, onActionCalled, ["1"]);
// And now use the user action to create a popup menu
elements.it2be_gantt.addPopupAction(userAction);


addPopupSeparator
void  addPopupSeparator( )
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
void  

Supported Clients
SmartClient


addToolbarButton
void  addToolbarButton( IGUserAction )
Add a button to the toolbar.
Parameters
IGUserAction  userAction  the user action

Returns
void  

Supported Clients
SmartClient

Sample
// AFTER initializing the bean you can start adding (toggle) buttons to the toolbar
// The way to do this is to create a user action first
var userAction = elements.it2be_gantt.createUserAction("action 2", "", "media:// /yourimage.gif", onActionCalled, ["2"]);
// And now use the user action to create a button and add it to the toolbar
elements.it2be_gantt.addToolbarButton(userAction);
// And now use the user action to create a toggle button and add it to the toolbar
elements.it2be_gantt.addToolbarToggleButton(userAction);


addToolbarToggleButton
void  addToolbarToggleButton( IGUserAction )
Add a toggle button to the toolbar.
Parameters
IGUserAction  userAction  the user action

Returns
void  

Supported Clients
SmartClient

Sample
// AFTER initializing the bean you can start adding (toggle) buttons to the toolbar
// The way to do this is to create a user action first
var userAction = elements.it2be_gantt.createUserAction("action 2", "", "media:// /yourimage.gif", onActionCalled, ["2"]);
// And now use the user action to create a button and add it to the toolbar
elements.it2be_gantt.addToolbarButton(userAction);
// And now use the user action to create a toggle button and add it to the toolbar
elements.it2be_gantt.addToolbarToggleButton(userAction);


clearPopupActions
void  clearPopupActions( )
Clear all actions from the popup menu.
Returns
void  

Supported Clients
SmartClient


connectNorthBean
void  connectNorthBean( IGanttComponent )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
IGanttComponent  component  the nort gantt

Returns
void  

Supported Clients
SmartClient


connectSouthBean
void  connectSouthBean( IGanttComponent )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
IGanttComponent  component  the sourt gantt

Returns
void  

Supported Clients
SmartClient


createUserAction
IGUserAction  createUserAction( String, String, Object, Function, Array<String> )
Create a (user) action to be used to add to a toolbar button or popup action.
Parameters
String  actionId  the action id
String  label  the label
Object  icon  the icon
Function  method  the method
Array<String>  arguments  the arguments

Returns
IGUserAction  action IGUserAction

Supported Clients
SmartClient

Sample
// Create a (user) action to be used to add to a toolbar button or popup action.
var userAction = elements.it2be_gantt.createUserAction("action 1", "action 1", null, onActionCalled, ["1"]);


enablePopupAction
void  enablePopupAction( String, Boolean )
Enable a popup action by action ID.
Parameters
String  actionId  the action id
Boolean  enable  the enable

Returns
void  

Supported Clients
SmartClient

Sample
// AFTER initializing the bean you can start adding actions to the popup menu
// The way to do this is to create a user action first
var userAction = elements.it2be_gantt.createUserAction("action 1", "action 1", null, onActionCalled, ["1"]);
// And now use the user action to create a popup menu
elements.it2be_gantt.addPopupAction(userAction);


enableToolbarButton
void  enableToolbarButton( String, Boolean )
Enable a toolbar button by action ID.
Parameters
String  actionId  the action id
Boolean  enable  the enable

Returns
void  

Supported Clients
SmartClient

Sample
// AFTER initializing the bean you can start adding (toggle) buttons to the toolbar
// The way to do this is to create a user action first
var userAction = elements.it2be_gantt.createUserAction("action 2", "", "media:// /yourimage.gif", onActionCalled, ["2"]);
// And now use the user action to create a button and add it to the toolbar
elements.it2be_gantt.addToolbarButton(userAction);
// And now use the user action to create a toggle button and add it to the toolbar
elements.it2be_gantt.addToolbarToggleButton(userAction);


expandGroupByNodeId
void  expandGroupByNodeId( Object, Boolean )
Expand or collapse a group by the id of a child node (use optional 'expand' argument false to collapse).
Parameters
Object  identifier  the identifier
Boolean  expand  the expand

Returns
void  

Supported Clients
SmartClient


expandNodeById
void  expandNodeById( Object, Boolean )
Expand or collapse a node by id (use optional 'expand' argument false to collapse).
Parameters
Object  identifier  the identifier
Boolean  expand  the expand

Returns
void  

Supported Clients
SmartClient


getCenterRibbonTimescaleDateFormats
Array<String>  getCenterRibbonTimescaleDateFormats( )
Get the formatting options for the center ribbon of the timescale (see sample).
Returns
Array<String>  formats String[]

Supported Clients
SmartClient

Sample
// Get the formatting options for the upper ribbon of the timescale.
var upperPatterns = elements.it2be_gantt.getUpperRibbonTimescaleDateFormats();
for (var i = 0 ; i < upperPatterns.length ; i++) {
application.output(upperPatterns[i]);


// Set the formatting options for all three ribbons of the timescale.
var upperPatterns = ["MMMM yyyy","MMM yyyy","MMM yy","MM yy","M yy"];
var centerPatterns = ["EEEE dd.MM.","EE dd.MM.","dd.MM.","dd"];
var lowerPatterns = null;

elements.it2be_gantt.setTimeScaleRibbonsDateFormats(upperPatterns, centerPatterns, lowerPatterns);


getDateLineDelay
Number  getDateLineDelay( )
Get the dateline refresh rate.
Returns
Number  delay int

Supported Clients
SmartClient


getHeight
Number  getHeight( )
Get the height.
Returns
Number  height int

Supported Clients
SmartClient


getLocationX
Number  getLocationX( )
Get X location.
Returns
Number  x int

Supported Clients
SmartClient


getLocationY
Number  getLocationY( )
Get Y location.
Returns
Number  y int

Supported Clients
SmartClient


getLowerRibbonTimescaleDateFormats
Array<String>  getLowerRibbonTimescaleDateFormats( )
Get the formatting options for the lower ribbon of the timescale (see sample).
Returns
Array<String>  formats String[]

Supported Clients
SmartClient

Sample
// Get the formatting options for the upper ribbon of the timescale.
var upperPatterns = elements.it2be_gantt.getUpperRibbonTimescaleDateFormats();
for (var i = 0 ; i < upperPatterns.length ; i++) {
application.output(upperPatterns[i]);


// Set the formatting options for all three ribbons of the timescale.
var upperPatterns = ["MMMM yyyy","MMM yyyy","MMM yy","MM yy","M yy"];
var centerPatterns = ["EEEE dd.MM.","EE dd.MM.","dd.MM.","dd"];
var lowerPatterns = null;

elements.it2be_gantt.setTimeScaleRibbonsDateFormats(upperPatterns, centerPatterns, lowerPatterns);


getName
String  getName( )
Get name.
Returns
String  name String

Supported Clients
SmartClient


getPopupActions
Array<String>  getPopupActions( )
Find all actions of the popup menu.
Returns
Array<String>  String[]

Supported Clients
SmartClient


getUpperRibbonTimescaleDateFormats
Array<String>  getUpperRibbonTimescaleDateFormats( )
Get the formatting options for the upper ribbon of the timescale (see sample).
Returns
Array<String>  formats String[]

Supported Clients
SmartClient

Sample
// Get the formatting options for the upper ribbon of the timescale.
var upperPatterns = elements.it2be_gantt.getUpperRibbonTimescaleDateFormats();
for (var i = 0 ; i < upperPatterns.length ; i++) {
application.output(upperPatterns[i]);


// Set the formatting options for all three ribbons of the timescale.
var upperPatterns = ["MMMM yyyy","MMM yyyy","MMM yy","MM yy","M yy"];
var centerPatterns = ["EEEE dd.MM.","EE dd.MM.","dd.MM.","dd"];
var lowerPatterns = null;

elements.it2be_gantt.setTimeScaleRibbonsDateFormats(upperPatterns, centerPatterns, lowerPatterns);


getWidth
Number  getWidth( )
Get the width.
Returns
Number  width int

Supported Clients
SmartClient


initialize
void  initialize( )
Initialize all Gantt settings.
Returns
void  

Supported Clients
SmartClient

Sample
// Initialize all Gantt settings.
// Start creating the bean
// IMPORTANT All settings should be done before you initialize the bean


isShowOptionsButton
Boolean  isShowOptionsButton( )
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
Boolean  result boolean

Supported Clients
SmartClient


refresh
void  refresh( )
Refresh the calendar (reloads and repaints everything).
Returns
void  

Supported Clients
SmartClient


removeAllNodes
void  removeAllNodes( )
Also see JGantt ServoyClientSupport available at netronic.com.
Returns
void  

Supported Clients
SmartClient


removeLinksById
void  removeLinksById( Array<Object> )
Remove links using an array of record id's.
Parameters
Array<Object>  identifiers  the identifiers

Returns
void  

Supported Clients
SmartClient


removeNodesById
void  removeNodesById( Array<Object> )
Remove nodes using an array of record id's.
Parameters
Array<Object>  identifiers  the identifiers

Returns
void  

Supported Clients
SmartClient


removePopupAction
void  removePopupAction( String )
Remove a popup action by action ID.
Parameters
String  actionId  the action id

Returns
void  

Supported Clients
SmartClient

Sample
// AFTER initializing the bean you can start adding actions to the popup menu
// The way to do this is to create a user action first
var userAction = elements.it2be_gantt.createUserAction("action 1", "action 1", null, onActionCalled, ["1"]);
// And now use the user action to create a popup menu
elements.it2be_gantt.addPopupAction(userAction);


removeToolbarButton
void  removeToolbarButton( String )
Remove a toolbar button by action ID.
Parameters
String  actionId  the action id

Returns
void  

Supported Clients
SmartClient


scrollToNodeWithId
void  scrollToNodeWithId( Object )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
Object  identifier  the identifier

Returns
void  

Supported Clients
SmartClient


selectLinksById
void  selectLinksById( Array<Object>, Boolean )
Select links using an array of record id's (use optional 'select' argument false to unselect).
Parameters
Array<Object>  identifiers  the identifiers
Boolean  select  the select

Returns
void  

Supported Clients
SmartClient


selectLinksById
void  selectLinksById( Array<Object> )
Select links using an array of record id's (use optional 'select' argument false to unselect).
Parameters
Array<Object>  identifiers  the identifiers

Returns
void  

Supported Clients
SmartClient


selectNodesById
void  selectNodesById( Array<Object>, Boolean )
Select nodes using an array of record id's (use optional 'select' argument false to unselect).
Parameters
Array<Object>  identifiers  the identifiers
Boolean  select  the select

Returns
void  

Supported Clients
SmartClient


selectNodesById
void  selectNodesById( Array<Object> )
Select nodes using an array of record id's (use optional 'select' argument false to unselect).
Parameters
Array<Object>  identifiers  the identifiers

Returns
void  

Supported Clients
SmartClient


setAnnotation
void  setAnnotation( IGAnnotation )
Set the annotation object (IGAnnotation) for a node.
Parameters
IGAnnotation  annotation  the annotation

Returns
void  

Supported Clients
SmartClient


setDateRange
void  setDateRange( Date, Date )
Get/Set the date range.
Parameters
Date  start  the start
Date  end  the end

Returns
void  

Supported Clients
SmartClient


setDateRangeChangedMethod
void  setDateRangeChangedMethod( Function )
Set the method to execute at date range change.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setDynamicNodeColors
void  setDynamicNodeColors( String, Array<Object> )
Set the the column, values and colors for which colors should switch.
Parameters
String  field  the field
Array<Object>  colorMap  the color map

Returns
void  

Supported Clients
SmartClient

Sample
// Set the the column, values and colors for which colors should switch.
// Optionally it is possible to add a scheme for triggering different colors
// The first argument is the column name of the column that the values should be validated against
// The second argument is an array holding the actual values and the colors
var scheme = new Array();
scheme[0] = ["Bertha Smith", "#9999ff"];
scheme[1] = ["Cornelius Rosenberg", "#cc99ff"];
scheme[2] = ["Dolores Oftheimer", "#ff99cc"];
scheme[3] = ["Jan Aleman", "#ffff99"];
scheme[4] = ["Rufus Miller", "#99ff99"];
scheme[5] = ["Trainee", null];
elements.it2be_gantt.setDynamicNodeColors("resources", scheme);


setGanttFont
void  setGanttFont( String )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
String  fontString  the font string

Returns
void  

Supported Clients
SmartClient


setGroupsDataSet
void  setGroupsDataSet( JSDataSet, Array<String> )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
JSDataSet  dataSet  the data set
Array<String>  columnNames  the column names

Returns
void  

Supported Clients
SmartClient


setInfoWindowLabel
void  setInfoWindowLabel( Number, String )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
Number  index  the index
String  title  the title

Returns
void  

Supported Clients
SmartClient


setLinkChangedMethod
void  setLinkChangedMethod( Function, Boolean )
Set the method to execute after changing a Link.
Parameters
Function  method
Boolean  returnAllValues

Returns
void  

Supported Clients
SmartClient


setLinkChangedMethod
void  setLinkChangedMethod( Function )
Set the method to execute after changing a Link.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setLinkCreatedMethod
void  setLinkCreatedMethod( Function )
Set the method to execute after creating a Link.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setLinkDeletedMethod
void  setLinkDeletedMethod( Function )
Set the method to execute after deleting a Link .
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setLinkDraggedMethod
void  setLinkDraggedMethod( Function )
Set the method to execute at link dragging (returns ID and values).
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setLinkRecords
void  setLinkRecords( JSDataSet )
Add/create links by adding a DataSet (make sure the columns and datatypes are the same as used on load).
Parameters
JSDataSet  set  the data set

Returns
void  

Supported Clients
SmartClient


setLinkSelectedMethod
void  setLinkSelectedMethod( Function )
Set the method to execute after selecting a Link.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setLinkWillChangeMethod
void  setLinkWillChangeMethod( Function )
Set the method to execute before a Link is changed (return true to prevent it from happening).
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setLinkWillChangeMethod
void  setLinkWillChangeMethod( Function, Boolean )
Set the method to execute before a Link is changed (return true to prevent it from happening).
Parameters
Function  method  the method
Boolean  returnAllValues  the return all values

Returns
void  

Supported Clients
SmartClient


setLinkWillCreateMethod
void  setLinkWillCreateMethod( Function )
Set the method to execute before a Link is created (return true to prevent it from happening).
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setLinkWillDeleteMethod
void  setLinkWillDeleteMethod( Function )
Set the method to execute before a Link is deleted (return true to prevent it from happening).
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setLinksDataSet
void  setLinksDataSet( JSDataSet, Array<String> )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
JSDataSet  set  the data set
Array<String>  columnNames  the column names

Returns
void  

Supported Clients
SmartClient


setLocation
void  setLocation( Number, Number )
Set the location.
Parameters
Number  x  the x
Number  y  the y

Returns
void  

Supported Clients
SmartClient


setMousePressedMethod
void  setMousePressedMethod( Function )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodeChangedMethod
void  setNodeChangedMethod( Function )
Set the method to execute after changing a node.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodeChangedMethod
void  setNodeChangedMethod( Function, Boolean )
Set the method to execute after changing a node.
Parameters
Function  method  the method
Boolean  returnAllValues  the return all values

Returns
void  

Supported Clients
SmartClient


setNodeCreatedMethod
void  setNodeCreatedMethod( Function )
Set the method to execute after creating a node.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodeDateColumns
void  setNodeDateColumns( String, String )
Set both start and end column names.
Parameters
String  startColumn  the start column
String  endColumn  the end column

Returns
void  

Supported Clients
SmartClient


setNodeDeletedMethod
void  setNodeDeletedMethod( Function )
Set the method to execute after deleting a node.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodeDraggedMethod
void  setNodeDraggedMethod( Function )
Set the method to execute at node dragging (returns ID and values).
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodeIdColumns
void  setNodeIdColumns( Array<String> )
Can be used to set a combined (unique) key instead of the record id. This key will also be returned in all methods.
Parameters
Array<String>  fields  the column names

Returns
void  

Supported Clients
SmartClient


setNodeProgressColumn
void  setNodeProgressColumn( String )
Set the name of the column that should be used to show the progress bar in a node.
Parameters
String  columnName  the column name

Returns
void  

Supported Clients
SmartClient

Sample
// Set the name of the column that should be used to show the progress bar in a node.
// column values should be integer values between 0 and 100
elements.it2be_gantt.setNodeProgressColumn("progress");
elements.it2be_gantt.progressColor = "FFAAGG";
elements.it2be_gantt.showNodeProgress = true;

elements.it2be_gantt.refresh();


setNodeRecords
void  setNodeRecords( JSDataSet )
Add/create nodes by adding a DataSet (make sure the columns and datatypes are the same as used on load).
Parameters
JSDataSet  set  the data set

Returns
void  

Supported Clients
SmartClient


setNodeSelectedMethod
void  setNodeSelectedMethod( Function )
Set the method to execute after selecting a node.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodeTooltipMethod
void  setNodeTooltipMethod( Function )
Set the method to execute at a node mouseover to return the tooltip text.
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodeWillChangeMethod
void  setNodeWillChangeMethod( Function )
Set the method to execute before a node is changed (return true to prevent it from happening).
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodeWillChangeMethod
void  setNodeWillChangeMethod( Function, Boolean )
Set the method to execute before a node is changed (return true to prevent it from happening).
Parameters
Function  method  the method
Boolean  returnAllValues  the return all values

Returns
void  

Supported Clients
SmartClient


setNodeWillCreateMethod
void  setNodeWillCreateMethod( Function )
Set the method to execute before a node is created (return true to prevent it from happening).
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodeWillDeleteMethod
void  setNodeWillDeleteMethod( Function )
Set the method to execute before a node is deleted (return true to prevent it from happening).
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setNodesDataSet
void  setNodesDataSet( JSDataSet, Array<Object>, String )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
JSDataSet  dataSet  the data set
Array<Object>  columns  the columns
String  hierarchyColumn  the hierarchy column

Returns
void  

Supported Clients
SmartClient


setNodesDataSet
void  setNodesDataSet( JSDataSet )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
JSDataSet  dataSet  the data set

Returns
void  

Supported Clients
SmartClient


setNodesDataSet
void  setNodesDataSet( JSDataSet, Array<Object> )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
JSDataSet  dataSet  the data set
Array<Object>  columns  the columns

Returns
void  

Supported Clients
SmartClient


setOnDataChangedMethod
void  setOnDataChangedMethod( Function )
Set the on data changed callback method
Parameters
Function  method  the method

Returns
void  

Supported Clients
SmartClient


setScaleFactor
void  setScaleFactor( Number )
Set the scale factor of the chart (1 = 100%).
Parameters
Number  scale  the scale

Returns
void  

Supported Clients
SmartClient


setScheduler
void  setScheduler( IGScheduler )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
IGScheduler  scheduler  the scheduler

Returns
void  

Supported Clients
SmartClient


setShowFocus
void  setShowFocus( Boolean )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
Boolean  show  the show

Returns
void  

Supported Clients
SmartClient


setShowHistogram
void  setShowHistogram( String, String )
Set the name of the columns that hold the capacity and load values.
Parameters
String  groupsCapacityColumn  the groups capacity column
String  nodesLoadColumn  the nodes load column

Returns
void  

Supported Clients
SmartClient


setSize
void  setSize( Number, Number )
Set the size.
Parameters
Number  width  the width
Number  height  the height

Returns
void  

Supported Clients
SmartClient


setTable
void  setTable( Array<Object> )
Set the table headers.
Parameters
Array<Object>  columns  the columns

Returns
void  

Supported Clients
SmartClient

Sample
// Set the table headers.
// You need to set the names of the columns (1) and the display names (2) of the columns you want to show,
// using an array as shown below
// The (optional) 2nd argument is to inform the bean what the (display) name is of the hierarchy column
// in the table that you want to use to show the expand/collapse icon in
// The (optional) 3rd argument is to inform the bean what indentation is used for the hierarchy column
var tableColumns = new Array();
tableColumns[0] = ["node_name", "Node"];
tableColumns[1] = ["start_date", "Start"];
tableColumns[2] = ["end_date", "End"];
tableColumns[3] = ["resources", "Resources"];
tableColumns[4] = ["hierarchy_code", "Hierarchy"];
elements.it2be_gantt.setTable(tableColumns, "Node", 2);


setTable
void  setTable( Array<Object>, String, Number )
Set the table headers.
Parameters
Array<Object>  columns  the columns
String  hierarchyColumn  the hierarchy column
Number  hierarchyIndent  the hierarchy indent

Returns
void  

Supported Clients
SmartClient

Sample
// Set the table headers.
// You need to set the names of the columns (1) and the display names (2) of the columns you want to show,
// using an array as shown below
// The (optional) 2nd argument is to inform the bean what the (display) name is of the hierarchy column
// in the table that you want to use to show the expand/collapse icon in
// The (optional) 3rd argument is to inform the bean what indentation is used for the hierarchy column
var tableColumns = new Array();
tableColumns[0] = ["node_name", "Node"];
tableColumns[1] = ["start_date", "Start"];
tableColumns[2] = ["end_date", "End"];
tableColumns[3] = ["resources", "Resources"];
tableColumns[4] = ["hierarchy_code", "Hierarchy"];
elements.it2be_gantt.setTable(tableColumns, "Node", 2);


setTable
void  setTable( Array<Object>, String )
Set the table headers.
Parameters
Array<Object>  columns  the columns
String  hierarchyColumn  the hierarchy column

Returns
void  

Supported Clients
SmartClient

Sample
// Set the table headers.
// You need to set the names of the columns (1) and the display names (2) of the columns you want to show,
// using an array as shown below
// The (optional) 2nd argument is to inform the bean what the (display) name is of the hierarchy column
// in the table that you want to use to show the expand/collapse icon in
// The (optional) 3rd argument is to inform the bean what indentation is used for the hierarchy column
var tableColumns = new Array();
tableColumns[0] = ["node_name", "Node"];
tableColumns[1] = ["start_date", "Start"];
tableColumns[2] = ["end_date", "End"];
tableColumns[3] = ["resources", "Resources"];
tableColumns[4] = ["hierarchy_code", "Hierarchy"];
elements.it2be_gantt.setTable(tableColumns, "Node", 2);


setTableHeaderFont
void  setTableHeaderFont( String )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
String  font  the font

Returns
void  

Supported Clients
SmartClient


setTimeScaleCollapseDisplayMode
void  setTimeScaleCollapseDisplayMode( Number )
Define how non-working times are collapsed (use Plug-in properties for the display mode, optionally downsize values 0.0 - 1.0).
Parameters
Number  displayMode  the display mode

Returns
void  

Supported Clients
SmartClient


setTimeScaleCollapseDisplayMode
void  setTimeScaleCollapseDisplayMode( Number, Number )
Define how non-working times are collapsed (use Plug-in properties for the display mode, optionally downsize values 0.0 - 1.0).
Parameters
Number  displayMode  the display mode
Number  factor  the factor

Returns
void  

Supported Clients
SmartClient


setTimeScaleFont
void  setTimeScaleFont( String )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
String  font  the time scale font

Returns
void  

Supported Clients
SmartClient


setTimeScaleRibbonsDateFormats
void  setTimeScaleRibbonsDateFormats( Array<String>, Array<String>, Array<String> )
Set the formatting options for all three ribbons of the timescale (see sample).
Parameters
Array<String>  upperPatterns  the upper patterns
Array<String>  centerPatterns  the center patterns
Array<String>  lowerPatterns  the lower patterns

Returns
void  

Supported Clients
SmartClient

Sample
// Get the formatting options for the upper ribbon of the timescale.
var upperPatterns = elements.it2be_gantt.getUpperRibbonTimescaleDateFormats();
for (var i = 0 ; i < upperPatterns.length ; i++) {
application.output(upperPatterns[i]);


// Set the formatting options for all three ribbons of the timescale.
var upperPatterns = ["MMMM yyyy","MMM yyyy","MMM yy","MM yy","M yy"];
var centerPatterns = ["EEEE dd.MM.","EE dd.MM.","dd.MM.","dd"];
var lowerPatterns = null;

elements.it2be_gantt.setTimeScaleRibbonsDateFormats(upperPatterns, centerPatterns, lowerPatterns);


setTimeSpan
void  setTimeSpan( Object )
Also see JGantt ServoyClientSupport available at netronic.com.
Parameters
Object  value  the value

Returns
void  

Supported Clients
SmartClient