Difference between revisions of "QcsCustomColumn class"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=QcsCustomColumn
+
|Name=<nowiki>QcsCustomColumn</nowiki>
|Description=Represents a data cache specification column with data calculated from script.
+
|Description=<nowiki>Represents a data cache specification column with data calculated from script.</nowiki>
 
|Constructors=
 
|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=name|Description=Set column name.|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=dataType|Description=Set the data type the script will return (notice this is CgScript type, not DCS type)|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isFullColumn|Description=Does the script evaluate the whole column at a time or not|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=dcs|Description=Dcs the column should belong to}}
+
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Set column name.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>dataType</nowiki>|Description=<nowiki>Set the data type the script will return (notice this is CgScript type, not DCS type)</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isFullColumn</nowiki>|Description=<nowiki>Does the script evaluate the whole column at a time or not</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
|Description=Create a new boolean column true if the user for a row belongs to the given group.}}
+
|Description=<nowiki>Create a new boolean column true if the user for a row belongs to the given group.</nowiki>}}
 
|Methods=
 
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Delete|Description=Remove column from the dcs}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved}}
+
{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
+
|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=CgScript|HasGetter=1|HasSetter=1|Description=Get/set the cgscript for the column}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the cgscript for the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=ColumnType|HasGetter=1|Description=Get the source type of the column data}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=DataType|HasGetter=1|Description=Get the data type of the column}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsFullColumn|HasGetter=1|Description=Does the script evaluate the whole column at a time or not}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsFullColumn</nowiki>|HasGetter=1|Description=<nowiki>Does the script evaluate the whole column at a time or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Get/set the name of the column}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=PresentAsText|HasGetter=1|HasSetter=1|Description=Get/set if Show the data column as the option text}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 
}}
 
}}
 +
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
<span style="color:#DF8621">Create custom column</span>
 
<span style="color:#DF8621">Create custom column</span>

Revision as of 11:56, 25 April 2019

QcsCustomColumn



Represents a data cache specification column with data calculated from script.

Constructors

  • (string name "Set column name.", string dataType "Set the data type the script will return (notice this is CgScript type, not DCS type)", bool isFullColumn "Does the script evaluate the whole column at a time or not", DataCacheSpecification dcs "Dcs the column should belong to") - Create a new boolean column true if the user for a row belongs to the given group.

Methods

  • Empty ChangeDcs(DataCacheSpecification dcs "New DCS to put the column in") - Change column to belong to another DCS. The origin DCS is not altered
  • Empty Delete() - Remove column from the dcs
  • Empty Save() - Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved
  • string ToString() - The string representation of the object.

Properties

  • string CgScript { get; set; } - Get/set the cgscript for the column
  • string ColumnType { get; } - Get the source type of the column data
  • string DataType { get; } - Get the data type of the column
  • bool IsFullColumn { get; } - Does the script evaluate the whole column at a time or not
  • string Name { get; set; } - Get/set the name of the column
  • string ObjectTypeName { get; } - The name of the type of object.
  • bool PresentAsText { get; set; } - Get/set if Show the data column as the option text
  • TypeInformation TypeInformation { get; } - Get information about this class.


Examples

Create custom column

DataCacheSpecification dcs = new DataCacheSpecification(15638865);
QcsCustomColumn cc = new QcsCustomColumn("test", "number", false, dcs);
cc.CgScript = "if(Q1!=empty) return Q1; else return 1;";
cc.Save();
dcs.Save();

2018-08-13 10-18-03.png


Create custom full column

DataCacheSpecification dcs = new DataCacheSpecification(15638865);
QcsCustomColumn cc = new QcsCustomColumn("testfullcustom", "number", true, dcs);
cc.CgScript = "
	array result = {};
	number numberOfRow = Id.Count;
	for(number i = 0; i < numberOfRow; i++) {
		if (Q1[i] != empty)
			result.Add(Q1[i]);
		else result.Add(1);
	}
	return result;
";
cc.Save();
dcs.Save();

Create custom full column using fs.UpdatedNumberOfRows

DataCacheSpecification dcs = new DataCacheSpecification(15638865);
QcsCustomColumn cc = new QcsCustomColumn("testfullcustom", "number", true, dcs);
cc.CgScript = "
        array param = Workflow_getParameters();
        Dictionary localCache = param[0];
        FullCustomColumnSettings fs = param[1];
	array result = {};
	number numberOfRow = fs.UpdatedNumberOfRows;
	for(number i = 0; i < numberOfRow; i++) {
		if (Q1[i] != empty)
			result.Add(Q1[i]);
		else result.Add(1);
	}
	return result;
";
cc.Save();
dcs.Save();