Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 11.4   11.5   12.0   12.1   12.2   12.3   12.4   12.5   13.0   13.1    Statistic    FMM    Blog  

Matrix.Add

Adds a value to cells in matrix.

Component Version macOS Windows Linux Server iOS SDK
Matrix 10.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "Matrix.Add"; MatrixRef; Value { ; firstRow; lastRow; firstCol; lastCol } )   More

Parameters

Parameter Description Example Flags
MatrixRef The matrix reference number. $matrix
Value The value to add to all cells. 123
firstRow The index of first row.
Default is 0.
0 Optional
lastRow The index of last row.
Default is Matrix.Height-1.
5 Optional
firstCol The index of first column.
Default is 0.
0 Optional
lastCol The index of last column.
Default is Matrix.Width-1.
6 Optional

Result

Returns OK or error.

Description

Adds a value to cells in matrix.
We loop over all rows in all columns for the range and add the given value to the numbers.
If the cell doesn't contain a number, it's converted to a number like GetAsNumber().

Use Matrix.New or Matrix.NewWithSQL to create the matrix object before adding something to it.

Examples

Add one to each cell:

Set Variable [ $matrix ; Value: MBS("Matrix.New"; 5; 6) ]
# set values
Set Variable [ $r ; Value: MBS("Matrix.SetRow"; $matrix; 0; "Joe¶Miller¶New York¶123") ]
Set Variable [ $r ; Value: MBS("Matrix.SetRow"; $matrix; 1; "Bob¶Jones¶Washington¶234") ]
Set Variable [ $r ; Value: MBS("Matrix.SetRow"; $matrix; 2; "Jane¶Stones¶Los Angeles¶567") ]
# add one to all
Set Variable [ $r ; Value: MBS("Matrix.Add"; $matrix; 1; 0; 3; 3; 3) ]
# show numbers
Show Custom Dialog [ "Values" ; MBS("Matrix.GetColumn"; $matrix; 3) ]
# free
Set Variable [ $r ; Value: MBS("Matrix.Release"; $matrix) ]

See also

Release notes

Blog Entries

This function checks for a paid license.

Created 2nd April 2020, last changed 7th April 2022


Math.TextToNumber - Matrix.AddColumn

💬 Ask a question or report a problem


Start Chat