Skip to main content

datastore

Description​

A set of datastore methods

datastore: DatastoreMethods

Details​

Note, that Tasks and Links should be modified using the common API of Gantt. Modifying tasks or links directly in the datastore can produce unexpected results. Datastores are expected to be used for resources or other custom objects.

A new datastore can be created using createDatastore method. The datastore object possesses the following methods and events:

Methods​

parse (data): void​

Loads data from an array

Parameters:

  • data - (Array<object>) - the data to load

Example:

gantt.$resourcesStore.parse([
    { id: 1, text: "QA", parent: null },
    { id: 2, text: "Development", parent: null },
    { id: 3, text: "Sales", parent: null },
    { id: 4, text: "Other", parent: null },
    { id: 5, text: "Unassigned", parent: 4 },
    { id: 6, text: "John", parent: 1 },
    { id: 7, text: "Mike", parent: 2 },
    { id: 8, text: "Anna", parent: 2 },
    { id: 9, text: "Bill", parent: 3 },
    { id: 10, text: "Floe", parent: 3 }
]);
note

sample Resource load diagram

The twin of datastore.parse() is gantt.parse().

Calls the onBeforeParse , onItemLoading, onParse, and onStoreUpdated events.

getItem (id)​

Returns the item by its id

Parameters:

  • id - (string | number) - the id of the item

Returns: object | void - the item object

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const resource = store.getItem(resourceId);
note

sample Resource load diagram

The twins of datastore.getItem() are gantt.getTask() and gantt.getLink().

updateItem (id, item)​

Updates the specified item

Parameters:

  • id - (string | number) - the id of the item
  • item - (object) - an object the item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const resource = store.getItem(resourceId);
resource.text = "modified";
store.updateItem(resourceId);
// or
store.updateItem(resourceId, { text: "modified" });

The twins of datastore.updateItem() are gantt.updateTask() and gantt.updateLink().

Calls the onBeforeUpdate, onAfterUpdate and onStoreUpdated events.

removeItem (id)​

Deletes the specified item

Parameters:

  • id - (string | number) - the id of the item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.removeItem(resourceId);

The twins of datastore.removeItem() are gantt.deleteTask() and gantt.deleteLink().

Calls the onBeforeDelete, onAfterDelete and onStoreUpdated events.

isVisible (id)​

Checks whether the specified item is visible or hidden via filters

Parameters:

  • id - (string | number) - the id of the item

Returns: boolean - true if visible, false otherwise

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
if(store.isVisible(resourceId)){
    console.log(resourceId);
}

The twin of datastore.isVisible() is gantt.isTaskVisible().

getVisibleItems ()​

Returns the array of visible items

Returns: Array<object> - array of visible items

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const items = store.getVisibleItems();

addItem (item, index)​

Adds a new item to the datastore

Parameters:

  • item - (object) - the item object
  • index - (number) - the position the task will be added into (0 or greater)

Returns: number | string - the id of the item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const itemId = store.addItem({
    text: "Unassigned",
    parent:4
});

The twins of datastore.addItem() are gantt.addTask() and gantt.addLink().

Calls the onBeforeAdd, onAfterAdd and onStoreUpdated events.

changeId (oldId, newId)​

Changes the id of the item

Parameters:

  • oldId - (string | number) - the current item's id
  • newId - (string | number) - the new item's id

Example:

const store = gantt.getDatastore(gantt.config.resource_store);

const itemId = store.addItem({
    text: "Unassigned",
    parent:4
});

// itemId - temporary client-side id of the new item
// once item is saved to the database - update the client with the new id:

store.changeId(itemId, "databaseId");

The twins of datastore.changeId() are gantt.changeTaskId() and gantt.changeLinkId().

Calls the onIdChange event.

exists (id)​

Checks whether the specified item exists in the datastore

Parameters:

  • id - (string | number) - the item's id

Returns: boolean - true if exists, false otherwise

Example:

const store = gantt.getDatastore(gantt.config.resource_store);

if(store.exists(resourceId)){
    console.log(resourceId);
}

The twins of datastore.exists() are gantt.isTaskExists() and gantt.isLinkExists().

move (sindex, tindex)​

Moves an item to a new position

Parameters:

  • sindex - (number) - the index of the current position of the task
  • tindex - (number) - the index of the position that the item will be moved to

Example:

const store = gantt.getDatastore(gantt.config.resource_store);

// swap two items
const idA = 1;
const idB = 5;
const indexA = store.getIndexById(idA);
const indexB = store.getIndexById(idB);
store.move(indexB, indexA);

indexA = store.getIndexById(idA);
store.move(indexA, indexB);

The twin of datastore.move() is gantt.moveTask().

Call the onStoreUpdated event.

clearAll ()​

Clears the datastore

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.clearAll();

The twin of datastore.clearAll() is gantt.clearAll().

Calls the onClearAll, onBeforeStoreUpdate and onStoreUpdated events.

silent (callback)​

Execute the code without firing API events of the datastore

Parameters:

  • callback - (Function) - the callback function

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.silent(function(){
    store.eachItem(function(item){
        item.text += " modified";
        store.updateItem(item.id);
    });
});
store.refresh();

The twin of datastore.silent() is gantt.silent().

refresh (id)​

Fires repainting of events of the specified record, runs filters

Parameters:

  • id - (string | number) - optional, the id of the record

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.refresh(itemId); // repaints an item
store.refresh(); // repaints all items

The twins of datastore.refresh() are gantt.refreshTask() and gantt.refreshLink().

Calls the onBeforeStoreUpdate, onBeforeFilter, onFilterItem, onFilter and onStoreUpdated events.

count ()​

Returns the number of items that are currently loaded into the datastore

Returns: number - count of items

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onParse", function(){
    alert(store.count() + " items loaded");
});

The twins of datastore.count() are gantt.getTaskCount() and gantt.getLinkCount().

countVisible ()​

Returns the number of items that are currently visible

Returns: number - count of visible items

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
alert(store.countVisible() + " items are visible");

The twin of datastore.countVisible() is gantt.getVisibleTaskCount().

eachItem (callback)​

Iterates over all tasks of the datastore

Parameters:

  • callback - (Function) - the callback function

Example:

const store = gantt.getDatastore(gantt.config.resource_store);

let searchItems = [];
store.eachItem(function(item){
    if(!item.value){
        searchItems.push(item);
    }
});

The twin of datastore.eachItem() is gantt.eachTask().

filter ()​

Runs the filters and updates visible array of items

Normally, you don't need to call this method, it is called automatically from the store.refresh() method.

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.filter();

sort (field, desc, parent, silent)​

Sorts items in the resource grid

Parameters:

  • field - (string | Function) - the name of the column or a custom sorting function
  • desc - (boolean) - specifies the sorting direction: true - descending sort and false - ascending sort
  • parent - (string | number) - the id of the parent item
  • silent - (boolean) - specifies whether rendering should be invoked after reordering items

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.parse([
    { id: 1, text: "QA", parent: null },
    { id: 2, text: "Development", parent: null },
    { id: 3, text: "Sales", parent: null },
    { id: 4, text: "Other", parent: null },
    { id: 5, text: "Unassigned", parent: 4 },
    { id: 6, text: "John", parent: 1 },
    { id: 7, text: "Mike", parent: 2 },
    { id: 8, text: "Anna", parent: 2 },
    { id: 9, text: "Bill", parent: 3 },
    { id: 10, text: "Floe", parent: 3 }
]);

// sort the resource grid by the column
let resourceSortDirection = false;

function sortResources(){
    resourceSortDirection = !resourceSortDirection;
    gantt.getDatastore("resource").sort("text", resourceSortDirection)
    gantt.render();
}

or you can define a custom function for sorting:

let resourceSortDirection = false;

function sortResources(){
    resourceSortDirection = !resourceSortDirection;
    gantt.getDatastore("resource").sort(function (resource1, resource2){
        return resource1.id - resource2.id;
    }, resourceSortDirection)
    gantt.render();
}

The twin of datastore.sort() is gantt.sort().

getIndexRange (from, to)​

Returns records between the specified indexes

Parameters:

  • from - (number) - the position of the start record
  • to - (number) - the position of the end record

Returns: Array<object> - array of items

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const itemsInViewPort = store.getIndexRange(5, 10);// get items from 5th to 10th

getItems ()​

Returns all records of the datastore

Returns: Array<object> - array of all items

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const items = store.getItems();

The twins of datastore.getItems() are gantt.getTaskByTime() and gantt.getLinks().

getIdByIndex (index)​

Returns the id of the item by its index

Parameters:

  • index - (number) - the position of the item

Returns: string | number | void - item id or undefined

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const firstItem = store.getIdByIndex(0);

The twin of datastore.getIdByIndex() is gantt.getTaskByIndex().

getIndexById (id)​

Returns the index of the item by its id

Parameters:

  • id - (string | number) - the id of the item

Returns: number - item index or -1 if not found

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const itemIndex = store.getIndexById(5);

The twin of datastore.getIndexById() is gantt.getTaskIndex().

getFirst ()​

Returns the id of the first item of the datastore

Returns: string | number | null - id of first item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const firstId = store.getFirst();

getLast ()​

Returns the id of the last item of the datastore

Returns: string | number | null - id of last item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const lastId = store.getLast();

getNext (id)​

Returns the id of the next item of the datastore

Parameters:

  • id - (string | number) - the item's id

Returns: string | number | null - id of next item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const firstId = store.getFirst();
const secondId = store.getNext(firstId);

The twin of datastore.getNext() is gantt.getNext().

getPrev (id)​

Returns the id of the previous item of the datastore

Parameters:

  • id - (string | number) - the item's id

Returns: string | number | null - id of previous item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const prevId = store.getPrev(itemId);

The twin of datastore.getPrev() is gantt.getPrev().

destructor ()​

Clears the datastore and removes all attached event handlers

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.destructor();

The twin of datastore.destructor() is gantt.destructor().

attachEvent (name, handler, settings)​

Attaches the handler to an inner event of DataStore

Parameters:

  • name - (string) - the event's name, case-insensitive
  • handler - (Function) - the handler function
  • settings - (object) - optional, an object with settings for the event handler

Returns: string - event id

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onAfterSelect", function(id){
    gantt.refreshData();
});

The twin of datastore.attachEvent() is gantt.attachEvent().

callEvent (name, params)​

Calls an inner event

Parameters:

  • name - (string) - the event's name, case-insensitive
  • params - (Array<any>) - an array of the event-related data

Returns: boolean - true if event completed successfully

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.callEvent("CustomEvent", [param1, param2]);

The twin of datastore.callEvent() is gantt.callEvent().

detachEvent (id)​

Detaches a handler from an event

Parameters:

  • id - (string) - the event's id

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
const handlerId = store.attachEvent("onAfterSelect", function(id){
    gantt.refreshData();
});

// detach a listener
store.detachEvent(handlerId);

The twin of datastore.detachEvent() is gantt.detachEvent().

Events​

onItemLoading (item)​

Fires when an item is being loaded from the data source

Parameters:

  • item - (object) - the object of an item

Returns: boolean - Return false to prevent the default action

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onItemLoading", function(item){
    if(item.valid){ // filter items on loading by custom property
        return true;
    }
    return false;
});

The twin of the onItemLoading event of datastore is the onTaskLoading event of Gantt.

onBeforeParse (data)​

Fires before data started to be parsed

Parameters:

  • data - (Array<any>) - the array with the data that was loaded

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onBeforeParse", function(item){
    console.time("StoreParse");
});
store.attachEvent("onParse", function(item){
    console.timeEnd("StoreParse");
});

The twin of the onBeforeParse event of datastore is the onBeforeParse event of Gantt.

onParse (data)​

Fires after data were parsed but before they were rendered

Parameters:

  • data - (Array<any>) - the array with the data that was loaded

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onBeforeParse", function(item){
    console.time("StoreParse");
});
store.attachEvent("onParse", function(item){
    console.timeEnd("StoreParse");
});

The twin of the onParse event of datastore is the onParse event of Gantt.

onBeforeUpdate (id, item)​

Fires before an item is updated

Parameters:

  • id - (string | number) - the id of an item
  • item - (object) - the new (updated) object of the item

Returns: boolean - Return false to prevent the default action

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onBeforeUpdate", function(id, item){
    // your code here
    return true;
});

The twins of the onBeforeUpdate event of datastore are the onBeforeTaskUpdate and onBeforeLinkUpdate events of Gantt.

onAfterUpdate (id, item)​

Fires after an item is updated

Parameters:

  • id - (string | number) - the id of an item
  • item - (object) - the object of the item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onAfterUpdate", function(id, item){
    // your code here
});

The twins of the onAfterUpdate event of datastore are the onAfterTaskUpdate and onAfterLinkUpdate events of Gantt.

onBeforeDelete (id, item)​

Fires before an item is deleted

Parameters:

  • id - (string | number) - the id of an item
  • item - (object) - the object of the item

Returns: boolean - Return false to prevent the default action

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onBeforeDelete", function(id, item){
    // your code here
    return true;
});

The twins of the onBeforeDelete event of datastore are the onBeforeTaskDelete and onBeforeLinkDelete events of Gantt.

onAfterDelete (id, item)​

Fires after an item is deleted

Parameters:

  • id - (string | number) - the id of an item
  • item - (object) - the object of the item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onAfterDelete", function(id, item){
    // your code here
});

The twins of the onAfterDelete event of datastore are the onAfterTaskDelete and onAfterLinkDelete events of Gantt.

onBeforeAdd (id, item)​

Fires before a new item is added to the datastore

Parameters:

  • id - (string | number) - the id of an item
  • item - (object) - the object of the item

Returns: boolean - Return false to prevent the default action

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onBeforeAdd", function(id, item){
    // your code here
    return true;
});

The twins of the onBeforeAdd event of datastore are the onBeforeTaskAdd and onBeforeLinkAdd events of Gantt.

onAfterAdd (id, item)​

Fires after an item is added to the datastore

Parameters:

  • id - (string | number) - the id of an item
  • item - (object) - the object of the item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onAfterAdd", function(id, item){
    // your code here
});

The twins of the onAfterAdd event of datastore are the onAfterTaskAdd and onAfterLinkAdd events of Gantt.

onIdChange (id, newId)​

Fires when the id of an item is changed

Parameters:

  • id - (string | number) - the id of an item
  • newId - (string | number) - the new id of the item

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onIdChange", function(oldId, newId){
    // your code here
});

The twin of the onIdChange event of datastore is the onTaskIdChange event of Gantt.

onClearAll ()​

Fires after all items were removed from the datastore

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onClearAll", function(){
    // your code here
});

The twin of the onClearAll event of datastore is the onClear event of Gantt.

onBeforeStoreUpdate (id, item, action)​

Fires before the datastore is refreshed

Parameters:

  • id - (string | number | null) - the id of an item or null
  • item - (object | null) - the item object or null
  • action - (string | null) - the action type ("paint", "move", "add", "delete", null)

Returns: boolean - Return false to prevent the default action

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onBeforeStoreUpdate", function(id, item, action){
    // your code here
    return true;
});

onStoreUpdated (id, item, action)​

Fires after the datastore has been refreshed

Parameters:

  • id - (string | number | null) - the id of an item or null
  • item - (object | null) - the item object or null
  • action - (string | null) - the action type ("paint", "move", "add", "delete", null)

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onStoreUpdated", function(id, item, action){
    // your code here
});

onBeforeFilter ()​

Fires before filtering is applied

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onBeforeFilter", function(){
    console.time("filtering");
});
store.attachEvent("onFilter", function(){
    console.timeEnd("filtering");
});

onFilter ()​

Fires after the datastore has update the filtering state

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onBeforeFilter", function(){
    console.time("filtering");
});
store.attachEvent("onFilter", function(){
    console.timeEnd("filtering");
});

onFilterItem (id, item)​

Fires for each item during filtering

Parameters:

  • id - (string | number) - the id of an item
  • item - (object) - the item object

Returns: boolean - Return false to mark item as not visible

Example:

const store = gantt.getDatastore(gantt.config.resource_store);
store.attachEvent("onFilterItem", function(id, item){
    // your code here
    return true;
});

The twin of the onFilterItem event of datastore is the onBeforeTaskDisplay event of Gantt.

onDestroy ()​

Fires after the destructor() method is called

Example:

const datastore = gantt.createDatastore({
    name: gantt.config.resource_store,
    type: "treeDatastore",
    initItem: function (item) {
        item.parent = item.parent || gantt.config.root_id;
        item[gantt.config.resource_property] = item.parent;
        item.open = true;
        return item;
    }
});

datastore.attachEvent("onDestroy", function(){
    alert("free custom resources");
});

datastore.destructor();