Class: TrellisGrouping

TrellisGrouping

groupStrategies/trellisgrouping.js, line 61

Creates a new instance of the trellis group strategy.

Parameters:
Name Type Description
options Object

An object used to initialize TrellisGrouping.

Name Type Default Description
panelUnitWidth number 150 optional

The default group panel width.

gapSize number 4 optional

The default gap size between groups.

groupLayoutFn GC.Spread.Views.Plugins.TrellisGrouping~groupLayoutCallback optional

Used to set the width of the specified group and arrangement for the sub-group.

Type Definitions

groupStrategies/trellisgrouping.js, line 43

groupLayoutCallback(groupInfo){GC.Spread.Views.Plugins.TrellisGrouping~Layout}

This callback is displayed as part of the Requester class.

Parameters:
Name Type Description
groupInfo Object

Specified group information.

Returns: {GC.Spread.Views.Plugins.TrellisGrouping~Layout} layout - Specified group layout.

LayoutObject

Properties:
Name Type Description
units number

The group width is caculated by panelUnitWidth * units.

direction string

Specifies how to arrange the sub-group of the group, including 'vertical' and 'horizontal'.

Events

groupStrategies/trellisgrouping.js, line 23

dragDropping

Drag drop event. This event occurs before the user drags or drops a trellis item.

Type:
  • object
Properties:
Name Type Description
sender object

Indicates the control the action is for.

args object

Provides arguments that are useful for the event.

Properties
Name Type Description
status string

Indicates the drag drop status. The status can be 'beforeDragging' or 'beforeDropping'.

event object

The event.

dataItem object

The dragged data.

hitInfo object

Indicates the current information of the mouse location.

cancel boolean

If this option is set true, the current status is canceled.