thinkgeo.mapsuite.portablecore.regexstyle
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.regexstyle [2015/09/21 08:17] admin |
thinkgeo.mapsuite.portablecore.regexstyle [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.RegexStyle ====== | ====== ThinkGeo.MapSuite.Core.RegexStyle ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class allows you to draw features differently based on regular expression matching. | This class allows you to draw features differently based on regular expression matching. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} RegexStyle() ** | ** {{wiki:PublicMethod.gif|}} RegexStyle() ** | ||
| - | This is a constructor for the class. | + | * //This is a constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | If you use this constructor, you need to set the various properties manually. | + | * //If you use this constructor, you need to set the various properties manually.// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} RegexStyle(String,Collection<RegexItem>) ** | ** {{wiki:PublicMethod.gif|}} RegexStyle(String,Collection<RegexItem>) ** | ||
| - | This is a constructor for the class. | + | * //This is a constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Parameters == | == Parameters == | ||
| * //columnName// | * //columnName// | ||
| Line 31: | Line 34: | ||
| ** {{wiki:PublicMethod.gif|}} RegexStyle(String,Collection<RegexItem>,RegexMatching) ** | ** {{wiki:PublicMethod.gif|}} RegexStyle(String,Collection<RegexItem>,RegexMatching) ** | ||
| - | This is a constructor for the class. | + | * //This is a constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Parameters == | == Parameters == | ||
| * //columnName// | * //columnName// | ||
| Line 52: | Line 55: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 64: | Line 67: | ||
| ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 92: | Line 95: | ||
| ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 120: | Line 123: | ||
| ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 132: | Line 135: | ||
| ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 152: | Line 155: | ||
| ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 163: | Line 166: | ||
| * //canvas// | * //canvas// | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //filePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //stream// | ||
| - | * Type:Stream | ||
| * Description:N/A | * Description:N/A | ||
| Line 200: | Line 171: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 212: | Line 183: | ||
| ** {{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 228: | Line 199: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 240: | Line 211: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 253: | Line 224: | ||
| ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method draws the features on the canvas you provided. | + | * //This method draws the features on the canvas you provided.// |
| == Remarks == | == Remarks == | ||
| - | This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the canvas you provided. Each style based on its properties may draw each feature differently. When overriding this method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection. | + | * //This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the canvas you provided. Each style based on its properties may draw each feature differently. When overriding this method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.// |
| == Return Value == | == Return Value == | ||
| Line 281: | Line 252: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** | ||
| - | This method returns the column data for each feature that is required for the style to properly draw. | + | * //This method returns the column data for each feature that is required for the style to properly draw.// |
| == Remarks == | == Remarks == | ||
| - | This abstract method is called from the concrete public method GetRequiredFieldNames. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection. | + | * //This abstract method is called from the concrete public method GetRequiredFieldNames. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.// |
| == Return Value == | == Return Value == | ||
| Line 293: | Line 264: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 305: | Line 276: | ||
| ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** | ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 325: | Line 296: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 337: | Line 308: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 350: | Line 321: | ||
| ** {{wiki:PublicProperty.gif|}} RegexMatchingRule ** | ** {{wiki:PublicProperty.gif|}} RegexMatchingRule ** | ||
| - | This property gets and sets the regular expression matching rule. The rule determines whether we match the entire string or just any portion of it. | + | * //This property gets and sets the regular expression matching rule. The rule determines whether we match the entire string or just any portion of it.// |
| == Remarks == | == Remarks == | ||
| - | This is used to determine how much of a string needs to match a regular expression in order to declare it a match for that expression. Sometimes, you only need one part of the string to match in order for the expression to be considered a match; other times you may want the entire string to match. | + | * //This is used to determine how much of a string needs to match a regular expression in order to declare it a match for that expression. Sometimes, you only need one part of the string to match in order for the expression to be considered a match; other times you may want the entire string to match.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]] | * Type:[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]] | ||
| Line 358: | Line 329: | ||
| ** {{wiki:PublicProperty.gif|}} ColumnName ** | ** {{wiki:PublicProperty.gif|}} ColumnName ** | ||
| - | This property gets and sets the column name whose value will be tested against the regular expression. | + | * //This property gets and sets the column name whose value will be tested against the regular expression.// |
| == Remarks == | == Remarks == | ||
| - | This is the column we use for matching. | + | * //This is the column we use for matching.// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 366: | Line 337: | ||
| ** {{wiki:PublicProperty.gif|}} RegexItems ** | ** {{wiki:PublicProperty.gif|}} RegexItems ** | ||
| - | This property gets the collection of RegexItems. Each item can have its own regular expression to match. | + | * //This property gets the collection of RegexItems. Each item can have its own regular expression to match.// |
| == Remarks == | == Remarks == | ||
| - | You will want to add RegexItems to this collection. Each item can have its own style and matching string. | + | * //You will want to add RegexItems to this collection. Each item can have its own style and matching string.// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]> | * Type:Collection<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]> | ||
| Line 374: | Line 345: | ||
| ** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 382: | Line 353: | ||
| ** {{wiki:PublicProperty.gif|}} IsActive ** | ** {{wiki:PublicProperty.gif|}} IsActive ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 390: | Line 361: | ||
| ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** | ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<String> | * Type:Collection<String> | ||
| Line 398: | Line 369: | ||
| ** {{wiki:PublicProperty.gif|}} Filters ** | ** {{wiki:PublicProperty.gif|}} Filters ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<String> | * Type:Collection<String> | ||
| Line 407: | Line 378: | ||
| ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** | ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<String> | * Type:Collection<String> | ||
thinkgeo.mapsuite.portablecore.regexstyle.1442823427.txt.gz ยท Last modified: 2015/09/21 08:17 by admin