Revision as of 07:15, 9 July 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

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
int CountOptions() - Number of current options
object this[] { get; }(int index "Index") - Backward-compatible indexer
bool HasTag(string tag "Tag to work on") - Return true if tag is added
Array of string ListTags() - Return list of all added tags
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
Empty this[] { set; }(int index "Index", object value "Value to set") - Backward-compatible indexer
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

Properties

Color Color { get; set; } - Get/set Color for this axis
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)
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
string Text { get; set; } - Get/set Text (description)
TypeInformation TypeInformation { get; } - Get information about this class.
bool Weight { get; set; } - Get/set if used for weight

@@ Line 11: / Line 11: @@
 |Description=<nowiki>Add an option to current list</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AddOrUpdateAxisInAxisSet</nowiki>|Description=<nowiki>Add or Update this axis in the axis set of the given data cache</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>AddTag</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=string|Name=<nowiki>tag</nowiki>|Description=<nowiki>Tag to work on</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=int|Name=<nowiki>CountOptions</nowiki>|Description=<nowiki>Number of current options</nowiki>}}
-{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Description=<nowiki>Backward-compatible indexer</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters=
-{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>RemoveOption</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</nowiki>}}
-{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of option</nowiki>}}
+|Description=<nowiki>Backward-compatible indexer</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>HasTag</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=string|Name=<nowiki>tag</nowiki>|Description=<nowiki>Tag to work on</nowiki>}}
+|Description=<nowiki>Return true if tag is added</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Array of strings|Name=<nowiki>ListTags</nowiki>|Description=<nowiki>Return list of all added tags</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveOption</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=AxisOption|Name=<nowiki>option</nowiki>|Description=<nowiki>Option to remove</nowiki>}}
 |Description=<nowiki>Remove option</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>RemoveOption</nowiki>|Parameters=
 {{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index of option in the list</nowiki>}}
 |Description=<nowiki>Remove option</nowiki>}}
-{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Description=<nowiki>Backward-compatible indexer</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>RemoveTag</nowiki>|Parameters=
+{{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>}}
+{{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>}}
+|Description=<nowiki>Backward-compatible indexer</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>}}
 |Properties=
+{{CGscriptProperties_Template|ReturnType=Color|Name=<nowiki>Color</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Color for this axis</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=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>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Name (title)</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=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>}}