VS:AddWSColumnOperator

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Adds database column operator to specified column.

PROCEDURE AddWSColumnOperator(
                worksheet      :HANDLE;
                databaseRow    :INTEGER;
                column         :INTEGER;
                operatorType   :INTEGER);

def vs.AddWSColumnOperator(worksheet, databaseRow, column, operatorType):
    return None

Parameters

worksheet		HANDLE		Handle to worksheet.
databaseRow		INTEGER		Database row to be queried.
column		INTEGER		Column to be queried.
operatorType		INTEGER		Operator type.

Remarks

Operator type constants:

All operators = -1
Sort operator = 0
Summarise operator = 1

(2018-12-30 - Peter Vandewalle): To add a sum operator, first add all operators and then remove the sort operator and the summarise operator:

Vectorscript

AddWSColumnOperator(hWS, 1, 1, -1);
RemoveWSColumnOperator(hWS, 1, 1, 0);
RemoveWSColumnOperator(hWS, 1, 1, 1);

Python

vs.AddWSColumnOperator(hWS, 1, 1, -1)
vs.RemoveWSColumnOperator(hWS, 1, 1, 0)
vs.RemoveWSColumnOperator(hWS, 1, 1, 1)

Version

Availability: from Vectorworks 2012

See Also

VS Functions:

• RemoveWSColumnOperator

VS Functions:

• [[VS:RemoveWSColumnOperator| RemoveWSColumnOperator]]