Skip to content

datacollection_beforeadd_event.md

Latest commit

 

History

History
29 lines (21 loc) · 1.02 KB

datacollection_beforeadd_event.md

File metadata and controls

29 lines (21 loc) · 1.02 KB
sidebar_label beforeAdd
title JavaScript DataCollection - beforeAdd Event
description You can explore the beforeAdd event of DataCollection in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite.

beforeAdd

@short: fires before adding a new item/items into a data collection

@signature: {'beforeAdd: (newItem: IDataItem, batch: IDataItem[], index: number) => boolean | void;'}

@params:

  • newItem: object - the object of an added item
  • batch: array - an array of added items
  • index: number - the index of the added item within the batch

@returns: Return false to prevent an item adding into a data collection; otherwise, true.

@example: component.data.events.on("beforeAdd", function(newItem, batch, index){ console.log("New items will be added"); return true; });

@descr: