This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.portablecore.valueitem [2015/09/21 08:20] admin |
thinkgeo.mapsuite.portablecore.valueitem [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.ValueItem ====== | ====== ThinkGeo.MapSuite.Core.ValueItem ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This class represents a single value to match and styles to draw. | This class represents a single value to match and styles to draw. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 8: | Line 11: | ||
** {{wiki:PublicMethod.gif|}} ValueItem() ** | ** {{wiki:PublicMethod.gif|}} ValueItem() ** | ||
- | This is a constructor for the class. | + | * //This is a constructor for the class.// |
== Remarks == | == Remarks == | ||
- | If you use this constructor, you should set the necessary properties manually. | + | * //If you use this constructor, you should set the necessary properties manually.// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} ValueItem(String,AreaStyle) ** | ** {{wiki:PublicMethod.gif|}} ValueItem(String,AreaStyle) ** | ||
- | This is a constructor for the class. | + | * //This is a constructor for the class.// |
== Remarks == | == Remarks == | ||
- | It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultAreaStyle. | + | * //It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultAreaStyle.// |
== Parameters == | == Parameters == | ||
* //value// | * //value// | ||
Line 30: | Line 33: | ||
** {{wiki:PublicMethod.gif|}} ValueItem(String,LineStyle) ** | ** {{wiki:PublicMethod.gif|}} ValueItem(String,LineStyle) ** | ||
- | This is a constructor for the class. | + | * //This is a constructor for the class.// |
== Remarks == | == Remarks == | ||
- | It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultLineStyle. | + | * //It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultLineStyle.// |
== Parameters == | == Parameters == | ||
* //value// | * //value// | ||
Line 45: | Line 48: | ||
** {{wiki:PublicMethod.gif|}} ValueItem(String,PointStyle) ** | ** {{wiki:PublicMethod.gif|}} ValueItem(String,PointStyle) ** | ||
- | This is a constructor for the class. | + | * //This is a constructor for the class.// |
== Remarks == | == Remarks == | ||
- | It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultPointStyle. | + | * //It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultPointStyle.// |
== Parameters == | == Parameters == | ||
* //value// | * //value// | ||
Line 60: | Line 63: | ||
** {{wiki:PublicMethod.gif|}} ValueItem(String,TextStyle) ** | ** {{wiki:PublicMethod.gif|}} ValueItem(String,TextStyle) ** | ||
- | This is a constructor for the class. | + | * //This is a constructor for the class.// |
== Remarks == | == Remarks == | ||
- | It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultTextStyle. | + | * //It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultTextStyle.// |
== Parameters == | == Parameters == | ||
* //value// | * //value// | ||
Line 75: | Line 78: | ||
** {{wiki:PublicMethod.gif|}} ValueItem(String,Collection<Style>) ** | ** {{wiki:PublicMethod.gif|}} ValueItem(String,Collection<Style>) ** | ||
- | This is a constructor for the class. | + | * //This is a constructor for the class.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
* //value// | * //value// | ||
Line 92: | Line 95: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 104: | Line 107: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 120: | Line 123: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 132: | Line 135: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 145: | Line 148: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 157: | Line 160: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 170: | Line 173: | ||
** {{wiki:PublicProperty.gif|}} Value ** | ** {{wiki:PublicProperty.gif|}} Value ** | ||
- | This property gets and sets the value that we use to match with the feature data. If the value matches, we use the style for this item. | + | * //This property gets and sets the value that we use to match with the feature data. If the value matches, we use the style for this item.// |
== Remarks == | == Remarks == | ||
- | The value must match exactly. If more complex matching is required, we suggest you use the RegexStyle. The RegexStyle enables you to use regular expressions, which are very powerful for fuzzy matching. | + | * //The value must match exactly. If more complex matching is required, we suggest you use the RegexStyle. The RegexStyle enables you to use regular expressions, which are very powerful for fuzzy matching.// |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 178: | Line 181: | ||
** {{wiki:PublicProperty.gif|}} DefaultAreaStyle ** | ** {{wiki:PublicProperty.gif|}} DefaultAreaStyle ** | ||
- | This property gets and sets the default AreaStyle. You should use this style if your features are area-based. | + | * //This property gets and sets the default AreaStyle. You should use this style if your features are area-based.// |
== Remarks == | == Remarks == | ||
- | The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy. | + | * //The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy.// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | ||
Line 186: | Line 189: | ||
** {{wiki:PublicProperty.gif|}} DefaultLineStyle ** | ** {{wiki:PublicProperty.gif|}} DefaultLineStyle ** | ||
- | This property gets and sets the default LineStyle. You should use this style if your features are line-based. | + | * //This property gets and sets the default LineStyle. You should use this style if your features are line-based.// |
== Remarks == | == Remarks == | ||
- | The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy. | + | * //The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy.// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] | * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] | ||
Line 194: | Line 197: | ||
** {{wiki:PublicProperty.gif|}} DefaultPointStyle ** | ** {{wiki:PublicProperty.gif|}} DefaultPointStyle ** | ||
- | This property gets and sets the default PointStyle. You should use this style if your features are point-based. | + | * //This property gets and sets the default PointStyle. You should use this style if your features are point-based.// |
== Remarks == | == Remarks == | ||
- | The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy. | + | * //The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy.// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]] | * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]] | ||
Line 202: | Line 205: | ||
** {{wiki:PublicProperty.gif|}} DefaultTextStyle ** | ** {{wiki:PublicProperty.gif|}} DefaultTextStyle ** | ||
- | This property gets and sets the default TextStyle. You should use this style if your features are text-based (such as labels). | + | * //This property gets and sets the default TextStyle. You should use this style if your features are text-based (such as labels).// |
== Remarks == | == Remarks == | ||
- | The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy. | + | * //The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy.// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | ||
Line 210: | Line 213: | ||
** {{wiki:PublicProperty.gif|}} CustomStyles ** | ** {{wiki:PublicProperty.gif|}} CustomStyles ** | ||
- | This property gets the collection of custom styles. | + | * //This property gets the collection of custom styles.// |
== Remarks == | == Remarks == | ||
- | The custom styles allow you to use styles other than the default style properties of the class. In this way, you can use a DotDensityStyle or any other style in the API. | + | * //The custom styles allow you to use styles other than the default style properties of the class. In this way, you can use a DotDensityStyle or any other style in the API.// |
== Return Value == | == Return Value == | ||
* Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]> | * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]> |