Difference between revisions of "Axis class"
Nguyenduyan (talk | contribs) |
|||
| Line 7: | Line 7: | ||
|Description=<nowiki>Create new axis</nowiki>}} | |Description=<nowiki>Create new axis</nowiki>}} | ||
|Methods= | |Methods= | ||
| + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddAccessGroup</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Group to give access</nowiki>}} | ||
| + | |Description=<nowiki>Add a new group that has access to this option.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>AddOption</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>AddOption</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=AxisOption|Name=<nowiki>option</nowiki>|Description=<nowiki>Option to add</nowiki>}} | {{CGscriptParameters_Template|Type=AxisOption|Name=<nowiki>option</nowiki>|Description=<nowiki>Option to add</nowiki>}} | ||
| Line 15: | Line 18: | ||
|Description=<nowiki>Add a new tag. Return false if already added</nowiki>}} | |Description=<nowiki>Add a new tag. Return false if already added</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>AddToAxisSet</nowiki>|Description=<nowiki>Add this axis to the axis set of the given data cache. Return false if Name already exists</nowiki>}} | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>AddToAxisSet</nowiki>|Description=<nowiki>Add this axis to the axis set of the given data cache. Return false if Name already exists</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Contains</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=object|Name=<nowiki>element</nowiki>|Description=<nowiki>Element to check for</nowiki>}} | ||
| + | |Description=<nowiki>Return true if the array contains the element using the normal equal operator.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>CountOptions</nowiki>|Description=<nowiki>Number of current options</nowiki>}} | {{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>CountOptions</nowiki>|Description=<nowiki>Number of current options</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Except</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=array|Name=<nowiki>elements</nowiki>|Description=<nowiki>Elements to remove</nowiki>}} | ||
| + | |Description=<nowiki>Return all elements that does not exist in the other collection.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>First</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A function to test each element for a condition.</nowiki>}} | ||
| + | |Description=<nowiki>Returns the first element in a sequence that satisfies a specified condition.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>FirstOrDefault</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A function to test each element for a condition.</nowiki>}} | ||
| + | |Description=<nowiki>Returns the first element in a sequence that satisfies a specified condition or empty if not found.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Frequency</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=number|Name=<nowiki>number</nowiki>|Description=<nowiki>The number to search for</nowiki>}} | ||
| + | |Description=<nowiki>Counts the number of times a given Number object exists in the Array. Can only use if all the elements are of type Number</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}} | ||
|Description=<nowiki>Backward-compatible indexer</nowiki>}} | |Description=<nowiki>Backward-compatible indexer</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>HasAccessGroup</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>AccessGroup to work on</nowiki>}} | ||
| + | |Description=<nowiki>Return true if group is added</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>HasTag</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>HasTag</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>tag</nowiki>|Description=<nowiki>Tag to work on</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>tag</nowiki>|Description=<nowiki>Tag to work on</nowiki>}} | ||
|Description=<nowiki>Return true if tag is added</nowiki>}} | |Description=<nowiki>Return true if tag is added</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsCharacterArray</nowiki>|Description=<nowiki>check if array is an array of characters</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsNumericArray</nowiki>|Description=<nowiki>check if array is an array of integer numbers</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>IsStringArray</nowiki>|Description=<nowiki>check if array is an array of string</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=Array of numbers|Name=<nowiki>ListAccessGroups</nowiki>|Description=<nowiki>Return list of all added AccessGroups</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Array of strings|Name=<nowiki>ListTags</nowiki>|Description=<nowiki>Return list of all added tags</nowiki>}} | {{CGscriptMethods_Template|ReturnType=Array of strings|Name=<nowiki>ListTags</nowiki>|Description=<nowiki>Return list of all added tags</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>OrderBy</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Function|Name=<nowiki>comparer</nowiki>|Description=<nowiki>Function that compares two objects of the same type. Must return a signed integer that indicates the relative values of first param A and second param B. Value Less than 0 : A is less than B.Value 0 : A equals B.Value Greater than 0 : A is greater than B.It can also be a function that takes 1 parameter and returns a string or number.</nowiki>}} | ||
| + | |Description=<nowiki>Sorts the elements of a sequence in ascending order by using a specified comparer.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Randomize</nowiki>|Description=<nowiki>Randomize the order of the elements in the current array.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveAccessGroup</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>AccessGroup to work on</nowiki>}} | ||
| + | |Description=<nowiki>Remove a group.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveOption</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveOption</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=AxisOption|Name=<nowiki>option</nowiki>|Description=<nowiki>Option to remove</nowiki>}} | {{CGscriptParameters_Template|Type=AxisOption|Name=<nowiki>option</nowiki>|Description=<nowiki>Option to remove</nowiki>}} | ||
| Line 32: | Line 64: | ||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>tag</nowiki>|Description=<nowiki>Tag to work on</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>tag</nowiki>|Description=<nowiki>Tag to work on</nowiki>}} | ||
|Description=<nowiki>Remove a tag. Return false if not added</nowiki>}} | |Description=<nowiki>Remove a tag. Return false if not added</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Select</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A transform function to apply to each element.</nowiki>}} | ||
| + | |Description=<nowiki>Projects each element of a sequence into a new form.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>SelectMany</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Function|Name=<nowiki>selector</nowiki>|Description=<nowiki>A transform function to get each sub array.</nowiki>}} | ||
| + | |Description=<nowiki>Projects each array element of a sequence into a new form.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=<nowiki>value</nowiki>|Description=<nowiki>Value to set</nowiki>}} | ||
|Description=<nowiki>Backward-compatible indexer</nowiki>}} | |Description=<nowiki>Backward-compatible indexer</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Skip</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>n</nowiki>|Description=<nowiki>How many elements to skip</nowiki>}} | ||
| + | |Description=<nowiki>Get all but the n first elements.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Take</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>n</nowiki>|Description=<nowiki>How many elements to take</nowiki>}} | ||
| + | |Description=<nowiki>Get the n first elements.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>ToDictionary</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Function|Name=<nowiki>keySelector</nowiki>|Description=<nowiki>A transform function to get the key of each element.</nowiki>}} | ||
| + | |Description=<nowiki>Return a dictionary with the elements of the array.</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=Dictionary|Name=<nowiki>ToDictionary</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Function|Name=<nowiki>keySelector</nowiki>|Description=<nowiki>A transform function to get the key of each element.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Function|Name=<nowiki>valueSelector</nowiki>|Description=<nowiki>A transform function to get the value of each element.</nowiki>}} | ||
| + | |Description=<nowiki>Return a dictionary with the elements of the array.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>UpdateAxisInAxisSet</nowiki>|Description=<nowiki>Update this axis in the axis set of the given data cache. Return false if Name does not exist already</nowiki>}} | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>UpdateAxisInAxisSet</nowiki>|Description=<nowiki>Update this axis in the axis set of the given data cache. Return false if Name does not exist already</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>Where</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Function|Name=<nowiki>predicate</nowiki>|Description=<nowiki>A function that takes 1 parameter of the types in the array and return true/false</nowiki>}} | ||
| + | |Description=<nowiki>Filters a sequence of values based on a predicate.</nowiki>}} | ||
|Properties= | |Properties= | ||
| + | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Average</nowiki>|HasGetter=1|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=Color|Name=<nowiki>Color</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Color for this axis</nowiki>}} | {{CGscriptProperties_Template|ReturnType=Color|Name=<nowiki>Color</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Color for this axis</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>HasAccess</nowiki>|HasGetter=1|Description=<nowiki>Get if current logged in user has access (Voluntary access control, doesn't check inheritance, if no groups defined this returns true)</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>LocalizedTexts</nowiki>|HasGetter=1|Description=<nowiki>Get/set localized Text (description)</nowiki>}} | {{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>LocalizedTexts</nowiki>|HasGetter=1|Description=<nowiki>Get/set localized Text (description)</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>LocalizedTitles</nowiki>|HasGetter=1|Description=<nowiki>Get/set localized Titles</nowiki>}} | {{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>LocalizedTitles</nowiki>|HasGetter=1|Description=<nowiki>Get/set localized Titles</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>MathBase</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Math base (dcs column used to calculate statitics on)</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>MathBase</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Math base (dcs column used to calculate statitics on)</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>MathBaseModifier</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Math base modifier (filter for statistics calculations)</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>MathBaseModifier</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Math base modifier (filter for statistics calculations)</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Max</nowiki>|HasGetter=1|Description=<nowiki>Largest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Min</nowiki>|HasGetter=1|Description=<nowiki>Smallest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Name (unique id)</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Name (unique id)</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Options</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set options</nowiki>}} | {{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Options</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set options</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PctBase</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Percentage base (denominator) for all options</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PctBase</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Percentage base (denominator) for all options</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Text</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set | + | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Sum</nowiki>|HasGetter=1|Description=<nowiki>Sum of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}} |
| + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Text</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set default language text (description)</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Weight</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if used for weight</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Weight</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if used for weight</nowiki>}} | ||
Revision as of 04:19, 9 August 2018
Axis
Represents an axis in a data cache specification.
Constructors
- (DataCacheSpecification dataCache "Validate against this data cache", string name "Initial name", string text "Initial text") - Create new axis
Methods
- Empty AddAccessGroup(int groupResourceId "Group to give access") - Add a new group that has access to this option.
- int AddOption(AxisOption option "Option to add") - Add an option to current list
- Empty AddOrUpdateAxisInAxisSet() - Add or Update this axis in the axis set of the given data cache
- bool AddTag(string tag "Tag to work on") - Add a new tag. Return false if already added
- bool AddToAxisSet() - Add this axis to the axis set of the given data cache. Return false if Name already exists
- bool Contains(object element "Element to check for") - Return true if the array contains the element using the normal equal operator.
- int CountOptions() - Number of current options
- array Except(array elements "Elements to remove") - Return all elements that does not exist in the other collection.
- object First(Function selector "A function to test each element for a condition.") - Returns the first element in a sequence that satisfies a specified condition.
- object FirstOrDefault(Function selector "A function to test each element for a condition.") - Returns the first element in a sequence that satisfies a specified condition or empty if not found.
- int Frequency(number number "The number to search for") - Counts the number of times a given Number object exists in the Array. Can only use if all the elements are of type Number
- object this[] { get; }(int index "Index") - Backward-compatible indexer
- bool HasAccessGroup(int groupResourceId "AccessGroup to work on") - Return true if group is added
- bool HasTag(string tag "Tag to work on") - Return true if tag is added
- bool IsCharacterArray() - check if array is an array of characters
- bool IsNumericArray() - check if array is an array of integer numbers
- bool IsStringArray() - check if array is an array of string
- Array of number ListAccessGroups() - Return list of all added AccessGroups
- Array of string ListTags() - Return list of all added tags
- array OrderBy(Function comparer "Function that compares two objects of the same type. Must return a signed integer that indicates the relative values of first param A and second param B. Value Less than 0 : A is less than B.Value 0 : A equals B.Value Greater than 0 : A is greater than B.It can also be a function that takes 1 parameter and returns a string or number.") - Sorts the elements of a sequence in ascending order by using a specified comparer.
- Empty Randomize() - Randomize the order of the elements in the current array.
- Empty RemoveAccessGroup(int groupResourceId "AccessGroup to work on") - Remove a group.
- Empty RemoveOption(AxisOption option "Option to remove") - Remove option
- bool RemoveOption(int index "Index of option in the list") - Remove option
- bool RemoveTag(string tag "Tag to work on") - Remove a tag. Return false if not added
- array Select(Function selector "A transform function to apply to each element.") - Projects each element of a sequence into a new form.
- array SelectMany(Function selector "A transform function to get each sub array.") - Projects each array element of a sequence into a new form.
- Empty this[] { set; }(int index "Index", object value "Value to set") - Backward-compatible indexer
- array Skip(int n "How many elements to skip") - Get all but the n first elements.
- array Take(int n "How many elements to take") - Get the n first elements.
- Dictionary ToDictionary(Function keySelector "A transform function to get the key of each element.") - Return a dictionary with the elements of the array.
- Dictionary ToDictionary(Function keySelector "A transform function to get the key of each element.", Function valueSelector "A transform function to get the value of each element.") - Return a dictionary with the elements of the array.
- string ToString() - The string representation of the object.
- bool UpdateAxisInAxisSet() - Update this axis in the axis set of the given data cache. Return false if Name does not exist already
- array Where(Function predicate "A function that takes 1 parameter of the types in the array and return true/false") - Filters a sequence of values based on a predicate.
Properties
- number Average { get; } - Average of the objects in the Array object. Can only use if all the elements are of type Number
- Color Color { get; set; } - Get/set Color for this axis
- bool HasAccess { get; } - Get if current logged in user has access (Voluntary access control, doesn't check inheritance, if no groups defined this returns true)
- LocalizedString LocalizedTexts { get; } - Get/set localized Text (description)
- LocalizedString LocalizedTitles { get; } - Get/set localized Titles
- string MathBase { get; set; } - Get/set Math base (dcs column used to calculate statitics on)
- string MathBaseModifier { get; set; } - Get/set Math base modifier (filter for statistics calculations)
- number Max { get; } - Largest of all the objects in the Array object. Can only use if all the elements are of type Number
- number Min { get; } - Smallest of all the objects in the Array object. Can only use if all the elements are of type Number
- string Name { get; set; } - Get/set Name (unique id)
- string ObjectTypeName { get; } - The name of the type of object.
- array Options { get; set; } - Get/set options
- string PctBase { get; set; } - Get/set Percentage base (denominator) for all options
- number Sum { get; } - Sum of all the objects in the Array object. Can only use if all the elements are of type Number
- string Text { get; set; } - Get/set default language text (description)
- TypeInformation TypeInformation { get; } - Get information about this class.
- bool Weight { get; set; } - Get/set if used for weight
Examples
New Axis
DataCacheSpecification dcs = new DataCacheSpecification(15636760);
Axis axis = new Axis (dcs, "Gender", "Your Gender");
axis.MathBase = "Gender";
axis.PctBase = "Gender!=empty";
axis.AddOption(new AxisOption(dcs, "Male", "Gender == [1]"));
axis.AddOption(new AxisOption(dcs, "Female", "Gender == [2]"));
axis.AddToAxisSet();
dcs.Save();
print(Catglobe.Json.Encode(axis));
//{"id":"Gender","title":{},"desc":{"":"Your Gender"},"mathbase":"Gender","mathbasemod":"","pctbase":"Gender!=empty","color":"#00000000","options":[{"title":{"":"Male"},"expression":"Gender == [1]","pctbase":"","color":"#00000000","tags":[]},{"title":{"":"Female"},"expression":"Gender == [2]","pctbase":"","color":"#00000000","tags":[]}],"tags":[]}
Remove options
DCS_use(15636575);
Axis axis = AxisSet_getAxis("Gender");
array options = axis.Options;
for(number i=0; i<options.Count; i++)
{
AxisOption option = options[i];
axis.RemoveOption(option);
}
AxisSet_save();
