GridData Widget

GridData controls display 2-dimensional data array as a grid of rows and columns with an optional label. They are associated to an underlying GridData parameter.

You create them using the PPGLayout.AddItem method with the siControlGrid control type enum:

    // ** during parameter definition (for example, in the Define callback) **
    // use the convenience method to add the grid to the custom property
    var oParam = oPSet.AddGridParameter( "MyGrid" );

    // now to get the actual grid from the parameter, use [Get]Value (not [Get]Source)
    var oGrid = oParam.Value;
    oGrid.BeginEdit();
    oGrid.RowCount = 4;
    oGrid.ColumnCount = 4;
    oGrid.SetRowValues( 0, new Array(0, 0.5, 0.75, 0.1) );
    oGrid.SetRowValues( 1, new Array(0.1, 0.5, 0.75, 0.1) );
    oGrid.SetRowValues( 2, new Array(0.2, 0.99, 0.75, 0.1) );
    oGrid.SetRowValues( 3, new Array(0.3, 0.5, 0.75, 0.1) );

    var aCols = new Array( "R", "G", "B", "A" );
    for ( var i=0; i<4; i++ ) {
       oGrid.SetRowLabel( i, "Vertex "+i );
       oGrid.SetColumnLabel( i, aCols[i] );
    }
    oGrid.EndEdit();

    // ** during control creation (for example, in the DefineLayout callback) **
    // no convenience method for the grid control
    oLayout.AddItem( "MyGrid", "", siControlGrid );//oItem.SetAttribute(siDecimals, 0 );

The underlying GridData parameter is a real instance of a GridData object, so that all methods and properties available on the GridData object are available dynamically through Logic, using Parameter.Value (from PPG.Inspected), which returns a ProjectItemCollection which you use in turn to get the particular item’s parameter) to get a pointer to the GridData object (see Dynamically Changing Custom Properties).

| To get a sense of working with grid controls, check out the examples in the documentation for the GridData object.

The following item attributes are available:

Available on all Controls also as a property on the PPGItem object: | Common to many Controls: | Specific to the GridData control:
• siUILabel • siUIItems • siUIType • siUIWidthPercentage • siUILabelPercentage • siUILabelMinPixels | • siUINoLabel • siUIValueOnly • siUIContinue • siUICX • siUICY | • siUIGridColumnWidths • siUIGridLockColumnHeader • siUIGridLockRowHeader • siUIGridHideColumnHeader • siUIGridHideRowHeader

Autodesk Softimage v7.5