Difference between revisions of "FixedCrossTableDataSeries class"
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
− | |Name=FixedCrossTableDataSeries | + | |Name=<nowiki>FixedCrossTableDataSeries</nowiki> |
− | |Description=A data series used in FixedCrossTable | + | |Description=<nowiki>A data series used in FixedCrossTable</nowiki> |
− | |Constructors= | + | |InheritsFrom=object|Constructors= |
− | {{CGscriptConstructors_Template|Description=Construct new data series.}} | + | {{CGscriptConstructors_Template|Description=<nowiki>Construct new data series.</nowiki>}} |
|Methods= | |Methods= | ||
− | {{CGscriptMethods_Template|ReturnType=Empty|Name=Add|Parameters= | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Add</nowiki>|Parameters= |
− | {{CGscriptParameters_Template|Type=FixedCrossTableDataItem|Name=absolute|Description=Item to add.|Comma=,}}{{CGscriptParameters_Template|Type=FixedCrossTableDataItem|Name=percentage|Description=Item to add.}} | + | {{CGscriptParameters_Template|Type=FixedCrossTableDataItem|Name=<nowiki>absolute</nowiki>|Description=<nowiki>Item to add.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=FixedCrossTableDataItem|Name=<nowiki>percentage</nowiki>|Description=<nowiki>Item to add.</nowiki>}} |
− | |Description=Add new data item.}} | + | |Description=<nowiki>Add new data item.</nowiki>}} |
− | {{CGscriptMethods_Template|ReturnType=Empty|Name=Clear|Description=Clear collection.}} | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddStat</nowiki>|Parameters= |
− | {{CGscriptMethods_Template|ReturnType= | + | {{CGscriptParameters_Template|Type=FixedCrossTableDataItem|Name=<nowiki>statistic</nowiki>|Description=<nowiki>Item to add.</nowiki>}} |
− | {{CGscriptParameters_Template|Type= | + | |Description=<nowiki>Add new statistic item.</nowiki>}} |
− | |Description=Get an item based on a index.}} | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Clear</nowiki>|Description=<nowiki>Clear collection.</nowiki>}} |
− | {{CGscriptMethods_Template|ReturnType=Empty|Name=RemoveAt|Parameters= | + | {{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters= |
− | {{CGscriptParameters_Template|Type= | + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>The key used to lookup the absolute value.</nowiki>}} |
− | |Description=Remove an element.}} | + | |Description=<nowiki>Get an item based on a index.</nowiki>}} |
− | {{CGscriptMethods_Template|ReturnType=Empty|Name=this[] { set; }|Parameters= | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveAt</nowiki>|Parameters= |
− | {{CGscriptParameters_Template|Type= | + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index to remove.</nowiki>}} |
− | |Description=Set an item based on a index to the value given.}} | + | |Description=<nowiki>Remove an element.</nowiki>}} |
− | {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters= |
+ | {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>The key used to lookup the absolute value.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>The value to set.</nowiki>}} | ||
+ | |Description=<nowiki>Set an item based on a index to the value given.</nowiki>}} | ||
+ | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
|Properties= | |Properties= | ||
− | {{CGscriptProperties_Template|ReturnType=FixedCrossTableDataItem|Name=AbsoluteTotal|HasGetter=1|HasSetter=1|Description=Get/Set the total absolute value.}} | + | {{CGscriptProperties_Template|ReturnType=FixedCrossTableDataItem|Name=<nowiki>AbsoluteTotal</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the total absolute value.</nowiki>}} |
− | {{CGscriptProperties_Template|ReturnType= | + | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Count</nowiki>|HasGetter=1|Description=<nowiki>Number of elements.</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=FixedCrossTableDataItem|Name=PercentageTotal|HasGetter=1|HasSetter=1|Description=Get/Set the total percentage value.}} | + | {{CGscriptProperties_Template|ReturnType=FixedCrossTableDataItem|Name=<nowiki>PercentageTotal</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the total percentage value.</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|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
}} | }} | ||
Latest revision as of 07:43, 2 July 2020
FixedCrossTableDataSeries
A data series used in FixedCrossTable
Parent class
Inherits from object
Constructors
- () - Construct new data series.
Methods
- Empty Add(FixedCrossTableDataItem absolute "Item to add.", FixedCrossTableDataItem percentage "Item to add.") - Add new data item.
- Empty AddStat(FixedCrossTableDataItem statistic "Item to add.") - Add new statistic item.
- Empty Clear() - Clear collection.
- object this[] { get; }(int index "The key used to lookup the absolute value.") - Get an item based on a index.
- Empty RemoveAt(int index "Index to remove.") - Remove an element.
- Empty this[] { set; }(int index "The key used to lookup the absolute value.", object value "The value to set.") - Set an item based on a index to the value given.
- (From object) string ToString() - The string representation of the object.
Properties
- FixedCrossTableDataItem AbsoluteTotal { get; set; } - Get/Set the total absolute value.
- int Count { get; } - Number of elements.
- string ObjectTypeName { get; } - The name of the type of object.
- FixedCrossTableDataItem PercentageTotal { get; set; } - Get/Set the total percentage value.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Examples
FixedCrossTableDataItem dataItem = new FixedCrossTableDataItem();
dataItem.Value = 5;
dataItem.SignificanceZ = 10;
FixedCrossTableDataSeries dataserie = new FixedCrossTableDataSeries();
dataserie.Add(dataItem,dataItem);
dataserie.AbsoluteTotal.Value = 20;
dataserie.PercentageTotal.Value = 100;
print(dataserie[0].Value);
print(dataserie[0].SignificanceZ);
print(dataserie.AbsoluteTotal.Value);
print(dataserie.PercentageTotal.Value);