getSelectArea

returns the object of the select area

object getSelectArea(string area_name);

Parameters

area_namestringoptional, the name of the select area

Returns

objectthe object of the select area

Available only in PRO Edition

Example

var area = $$("dtable").getSelectArea();

Related samples

Details

if the area_name parameter isn't passed, the method returns the last selected area

The returned object of the select area contains the following parameters:

  • start - (object) the id object of the left top cell, contains two parameters: the row id and the column id
  • end - (object) the id object of the right cell, contains two parameters: the row id and the column id
  • preserve - (boolean) defines, if the previous select area should be saved, false by default
  • area_name - (string) optional, the name used to address to an area to change or to delete it; by default it's generated by webix.uid() method
  • css - (string) the css style (classname) for the border of an area. By default, the border of area selection is black
  • handle - (boolean) optional, enables/disables a handle for selection area resize (enabled by default)
See also
Back to top
If you have not checked yet, be sure to visit site of our main product Webix easy javascript framework and page of javascript data grid product.