Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.core.valueitem [2015/09/17 10:41]
admin
+++ thinkgeo.mapsuite.core.valueitem [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.ValueItem ======
+{{section>upgrade_map_suite_to_10.0}}
 This class represents a single value to match and styles to draw.
 ===== Inheritance Hierarchy =====
@@ Line 5: / Line 8: @@
     ***ThinkGeo.MapSuite.Core.ValueItem**
 ===== Members Summary =====
-=== Public Constructors ===
+==== Public Constructors ====
-<div class_table>
+** {{wiki:PublicMethod.gif|}} ValueItem() **
-**{{wiki:PublicMethod.gif|}}[[#ValueItem()|ValueItem]]**
-  * **Parameters**:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:This is a constructor for the class.
-</div>
-<div class_table>
+  * //This is a constructor for the class.//
-**{{wiki:PublicMethod.gif|}}[[#ValueItem(String,AreaStyle)|ValueItem]]**
+== Remarks ==
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+  * //If you use this constructor, you should set the necessary properties manually.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is a constructor for the class.
+<div newline></div>
-</div>
+** {{wiki:PublicMethod.gif|}} ValueItem(String,AreaStyle) **
-<div class_table>
+  * //This is a constructor for the class.//
-**{{wiki:PublicMethod.gif|}}[[#ValueItem(String,LineStyle)|ValueItem]]**
+== Remarks ==
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+  * //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.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is a constructor for the class.
+  * //value//
-</div>
+    * Type:String
+    * Description:This parameter is the value that will match with the data specified for the feature.
-<div class_table>
+  * //areaStyle//
-**{{wiki:PublicMethod.gif|}}[[#ValueItem(String,PointStyle)|ValueItem]]**
+    * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+    * Description:This parameter is the style you want to draw with if the value matches.
-  * **DeclaringType**:N/A
-  * **Summary**:This is a constructor for the class.
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#ValueItem(String,TextStyle)|ValueItem]]**
+** {{wiki:PublicMethod.gif|}} ValueItem(String,LineStyle) **
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-  * **DeclaringType**:N/A
-  * **Summary**:This is a constructor for the class.
-</div>
-<div class_table>
+  * //This is a constructor for the class.//
-**{{wiki:PublicMethod.gif|}}[[#ValueItem(String,Collection<Style>)|ValueItem]]**
+== Remarks ==
-  * **Parameters**:String,Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+  * //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.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is a constructor for the class.
+  * //value//
-</div>
+    * Type:String
+    * Description:This parameter is the value that will match with the data specified for the feature.
-=== Protected Constructors ===
+  * //lineStyle//
-=== Public Methods ===
+    * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
-<div class_table>
+    * Description:This parameter is the style you want to draw with if the value matches.
-**{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]**
-  * **Parameters**:Object
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]**
+** {{wiki:PublicMethod.gif|}} ValueItem(String,PointStyle) **
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //This is a constructor for the class.//
-**{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]**
+== Remarks ==
-  * **Parameters**:N/A
+  * //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.//
-  * **DeclaringType**:Object
+== Parameters ==
-  * **Summary**:N/A
+  * //value//
-</div>
+    * Type:String
+    * Description:This parameter is the value that will match with the data specified for the feature.
-<div class_table>
+  * //pointStyle//
-**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]**
+    * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
-  * **Parameters**:N/A
+    * Description:This parameter is the style you want to draw with if the value matches.
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-=== Protected Methods ===
+<div newline></div>
-<div class_table>
+** {{wiki:PublicMethod.gif|}} ValueItem(String,TextStyle) **
-**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]**
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //This is a constructor for the class.//
-**{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]**
+== Remarks ==
-  * **Parameters**:N/A
+  * //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.//
-  * **DeclaringType**:Object
+== Parameters ==
-  * **Summary**:N/A
+  * //value//
-</div>
+    * Type:String
+    * Description:This parameter is the value that will match with the data specified for the feature.
-=== Public Properties ===
+  * //textStyle//
-**{{wiki:PublicProperty.gif|}}[[#CustomStyles|CustomStyles]]**
+    * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-  * **Return**:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+    * Description:This parameter is the style you want to draw with if the value matches.
-  * **Summary**:This property gets the collection of custom styles.
-**{{wiki:PublicProperty.gif|}}[[#DefaultAreaStyle|DefaultAreaStyle]]**
+<div newline></div>
-  * **Return**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+** {{wiki:PublicMethod.gif|}} ValueItem(String,Collection<Style>) **
-  * **Summary**:This property gets and sets the default AreaStyle. You should use this style if your features are area-based.
-**{{wiki:PublicProperty.gif|}}[[#DefaultLineStyle|DefaultLineStyle]]**
+  * //This is a constructor for the class.//
-  * **Return**:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+== Remarks ==
-  * **Summary**:This property gets and sets the default LineStyle. You should use this style if your features are line-based.
+  * //N/A//
+== Parameters ==
+  * //value//
+    * Type:String
+    * Description:This parameter is the value that will match with the data specified for the feature.
-**{{wiki:PublicProperty.gif|}}[[#DefaultPointStyle|DefaultPointStyle]]**
+  * //customStyles//
-  * **Return**:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
-  * **Summary**:This property gets and sets the default PointStyle. You should use this style if your features are point-based.
+    * Description:This parameter represents the styles you want to draw with if the value matches.
-**{{wiki:PublicProperty.gif|}}[[#DefaultTextStyle|DefaultTextStyle]]**
+<div newline></div>
-  * **Return**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+==== Protected Constructors ====
-  * **Summary**:This property gets and sets the default TextStyle. You should use this style if your features are text-based (such as labels).
+==== Public Methods ====
+** {{wiki:PublicMethod.gif|}} ToString() **
-**{{wiki:PublicProperty.gif|}}[[#Value|Value]]**
+  * //N/A//
-  * **Return**:String
+== Remarks ==
-  * **Summary**: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.
+  * //N/A//
-=== Protected Properties ===
+== Return Value ==
-=== Public Events ===
+  * Type:String
-===== Public Constructors =====
+  * Description:N/A
-=== ValueItem() ===
-This is a constructor for the class.
-==== Remarks ====
-If you use this constructor, you should set the necessary properties manually.
-==== Parameters ====
-[[#Public Constructors|Go Back]]
-=== ValueItem(String,AreaStyle) ===
-This is a constructor for the class.
-==== 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.
-==== Parameters ====
-**value**
-  * **Type**:String
-  * **Description:This parameter is the value that will match with the data specified for the feature.
-**areaStyle**
+== Parameters ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+<div newline></div>
-  * **Description:This parameter is the style you want to draw with if the value matches.
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-[[#Public Constructors|Go Back]]
+  * //N/A//
-=== ValueItem(String,LineStyle) ===
+== Remarks ==
-This is a constructor for the class.
+  * //N/A//
-==== 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.
-==== Parameters ====
-**value**
-  * **Type**:String
-  * **Description:This parameter is the value that will match with the data specified for the feature.
-**lineStyle**
+== Return Value ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+  * Type:Boolean
-  * **Description:This parameter is the style you want to draw with if the value matches.
+  * Description:N/A
-[[#Public Constructors|Go Back]]
+== Parameters ==
-=== ValueItem(String,PointStyle) ===
+  * //obj//
-This is a constructor for the class.
+    * Type:Object
-==== Remarks ====
+    * Description:N/A
-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 ====
-**value**
-  * **Type**:String
-  * **Description:This parameter is the value that will match with the data specified for the feature.
-**pointStyle**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-  * **Description:This parameter is the style you want to draw with if the value matches.
-[[#Public Constructors|Go Back]]
+  * //N/A//
-=== ValueItem(String,TextStyle) ===
+== Remarks ==
-This is a constructor for the class.
+  * //N/A//
-==== 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.
-==== Parameters ====
-**value**
-  * **Type**:String
-  * **Description:This parameter is the value that will match with the data specified for the feature.
-**textStyle**
+== Return Value ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+  * Type:Int32
-  * **Description:This parameter is the style you want to draw with if the value matches.
+  * Description:N/A
-[[#Public Constructors|Go Back]]
+== Parameters ==
-=== ValueItem(String,Collection<Style>) ===
+<div newline></div>
-This is a constructor for the class.
+** {{wiki:PublicMethod.gif|}} GetType() **
-==== Remarks ====
-N/A
-==== Parameters ====
-**value**
-  * **Type**:String
-  * **Description:This parameter is the value that will match with the data specified for the feature.
-**customStyles**
+  * //N/A//
-  * **Type**:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+== Remarks ==
-  * **Description:This parameter represents the styles you want to draw with if the value matches.
+  * //N/A//
-[[#Public Constructors|Go Back]]
+== Return Value ==
-===== Protected Constructors =====
+  * Type:Type
-===== Public Methods =====
+  * Description:N/A
-=== Equals(Object) ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:Boolean
+<div newline></div>
-  * **Description**:N/A
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-==== Parameters ====
+  * //N/A//
-**obj**
+== Remarks ==
-  * **Type**:Object
+  * //N/A//
-  * **Description**:N/A
-[[#Public Methods|Go Back]]
+== Return Value ==
-=== GetHashCode() ===
+  * Type:Void
-N/A
+  * Description:N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:Int32
+<div newline></div>
-  * **Description**:N/A
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-==== Parameters ====
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-=== GetType() ===
+  * //N/A//
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Return Value ==
-  * **Return Type**:Type
+  * Type:Object
-  * **Description**:N/A
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-=== ToString() ===
+==== Public Properties ====
-N/A
+** {{wiki:PublicProperty.gif|}} Value **
-==== Remarks ====
-N/A
-**Return 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.
-  * **Return Type**:String
+== Remarks ==
-  * **Description**:N/A
+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 ==
+  * Type:String
-==== Parameters ====
+** {{wiki:PublicProperty.gif|}} DefaultAreaStyle **
-[[#Public Methods|Go Back]]
-===== Protected Methods =====
-=== Finalize() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
-  * **Return Type**:Void
-  * **Description**:N/A
-==== Parameters ====
-[[#Protected Methods|Go Back]]
-=== MemberwiseClone() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
-  * **Return Type**:Object
-  * **Description**:N/A
-==== Parameters ====
-[[#Protected Methods|Go Back]]
-===== Public Properties =====
-=== CustomStyles ===
-This property gets the collection of custom styles.
-==== 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.
-==== Return Value ====
-**Return Type**:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
-[[#Public Properties|Go Back]]
-=== DefaultAreaStyle ===
 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.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+** {{wiki:PublicProperty.gif|}} DefaultLineStyle **
-[[#Public Properties|Go Back]]
-=== DefaultLineStyle ===
 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.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+** {{wiki:PublicProperty.gif|}} DefaultPointStyle **
-[[#Public Properties|Go Back]]
-=== DefaultPointStyle ===
 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.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+** {{wiki:PublicProperty.gif|}} DefaultTextStyle **
-[[#Public Properties|Go Back]]
-=== DefaultTextStyle ===
 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.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-[[#Public Properties|Go Back]]
+** {{wiki:PublicProperty.gif|}} CustomStyles **
-=== 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 the collection of custom styles.
-==== 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 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 ==
-**Return Type**:String
+  * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
-[[#Public Properties|Go Back]]
+==== Protected Properties ====
-===== Protected Properties =====
+==== Public Events ====
-===== Public Events =====

User Tools

Site Tools

Differences

Page Tools