AxisOption class: Difference between revisions
From Catglobe Wiki
More actions
Nguyenduyan (talk | contribs) Created page with "{{CGscriptClass_Template |Name=<nowiki>AxisOption</nowiki> |Description=<nowiki>Represents an axis option in an axis.</nowiki> |Constructors= {{CGscriptConstructors_Template|P..." |
Nguyenduyan (talk | contribs) No edit summary |
||
| Line 7: | Line 7: | ||
|Description=<nowiki>Create new axis option</nowiki>}} | |Description=<nowiki>Create new axis option</nowiki>}} | ||
|Methods= | |Methods= | ||
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Description=<nowiki>Backward-compatible indexer</nowiki>}} | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>AddTag</nowiki>|Parameters= | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>this[] { set; }</nowiki>|Description=<nowiki>Backward-compatible indexer</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>tag</nowiki>|Description=<nowiki>Tag to work on</nowiki>}} | ||
|Description=<nowiki>Add a new tag, a tag cannot contain whitespace. Return false if already added</nowiki>}} | |||
{{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters= | |||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>index</nowiki>|Description=<nowiki>Index</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=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=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=Color|Name=<nowiki>Color</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Color for this option</nowiki>}} | |||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Expression</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Expression (nominator)</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Expression</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Expression (nominator)</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>LocalizedNames</nowiki>|HasGetter=1|Description=<nowiki>Get/set localized Name (title)</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 (title)</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PctBase</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Percentage base (denominator)</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>PctBase</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set Percentage base (denominator). If empty then inherit from Axis</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>}} | ||
}} | }} | ||
Revision as of 07:14, 9 July 2018
AxisOption
Represents an axis option in an axis.
Constructors
- (DataCacheSpecification dataCache "Validate against this data cache", string name "Initial name", string expression "Initial expression") - Create new axis option
Methods
- bool AddTag(string tag "Tag to work on") - Add a new tag, a tag cannot contain whitespace. Return false if already added
- 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
- 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.
Properties
- Color Color { get; set; } - Get/set Color for this option
- string Expression { get; set; } - Get/set Expression (nominator)
- LocalizedString LocalizedNames { get; } - Get/set localized Name (title)
- string Name { get; set; } - Get/set Name (title)
- string ObjectTypeName { get; } - The name of the type of object.
- string PctBase { get; set; } - Get/set Percentage base (denominator). If empty then inherit from Axis
- TypeInformation TypeInformation { get; } - Get information about this class.