thinkgeo.mapsuite.core.valueitem
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.valueitem [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.ValueItem ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class represents a single value to match and styles to draw. | ||
| - | === Remarks === | ||
| - | Value Style: | ||
| - | |||
| - | The ValueStyle allows you to match data in the FeatureSource against a value string. If the value matches, then we will use the style defined in that item to do the drawing. For example, let's say you have some data that contains states, and each state is categorized as either a high, medium or low pollution state. Based on the string values of "High", Medium" and "Low", we can match on these. If a feature's data for the column matched the string "High", then we would use the high ValueItem's styles to draw that feature. This can be applied to all kinds of things, such as road classifications, etc. | ||
| - | |||
| - | This can be somewhat slow because we have to match data from the FeatureSource. If performance is key, then instead of using the ValueStyle, we recommend that you create a set custom index for your layer, one index with only "High" elements, one for "Medium" and so on. Then load each as a separate layer. In this way, you would only have one data set, but multiple indexes. This is the fastest way if you are working with Shape Files. If you are working with spatial databases, then we suggest creating a view to segment out each category. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.Core.ValueItem]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueItem()|ValueItem]] | | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueItem(String, AreaStyle)|ValueItem]] | String, [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueItem(String, LineStyle)|ValueItem]] | String, [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueItem(String, PointStyle)|ValueItem]] | String, [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]] | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueItem(String, TextStyle)|ValueItem]] | String, [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueItem(String, Collection<Style>)|ValueItem]] | String, Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]> | | This is a constructor for the class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomStyles|CustomStyles]] | Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]> | | This property gets the collection of custom styles. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultAreaStyle|DefaultAreaStyle]] | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | | This property gets and sets the default AreaStyle. You should use this style if your features are area-based. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultLineStyle|DefaultLineStyle]] | [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] | | This property gets and sets the default LineStyle. You should use this style if your features are line-based. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultPointStyle|DefaultPointStyle]] | [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]] | | This property gets and sets the default PointStyle. You should use this style if your features are point-based. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultTextStyle|DefaultTextStyle]] | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | | This property gets and sets the default TextStyle. You should use this style if your features are text-based (such as labels). | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Value|Value]] | String | | 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. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== ValueItem() ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | If you use this constructor, you should set the necessary properties manually. | ||
| - | === Remarks === | ||
| - | If you use this constructor, you should set the necessary properties manually. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ValueItem(String, AreaStyle) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify an AreaStyle you want to use. You should use this if the features you are drawing are area-based. Alternatively, you can set the properties of the DefaultAreaSytle directly on 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | value | String<!-- System.String --> | This parameter is the value that will match with the data specified for the feature. | | ||
| - | | areaStyle | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.Core.AreaStyle --> | This parameter is the style you want to draw with if the value matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ValueItem(String, LineStyle) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify a LineStyle you want to use. You should use this if the features you are drawing are line-based. Alternatively, you can set the properties of the DefaultLineSytle directly on 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 DefaultLineStyle. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | value | String<!-- System.String --> | This parameter is the value that will match with the data specified for the feature. | | ||
| - | | lineStyle | [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]<!-- ThinkGeo.MapSuite.Core.LineStyle --> | This parameter is the style you want to draw with if the value matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ValueItem(String, PointStyle) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify a PointStyle you want to use. You should use this if the features you are drawing are point based. Alternatively, you can set the properties of the DefaultPointSytle directly on 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 DefaultPointStyle. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | value | String<!-- System.String --> | This parameter is the value that will match with the data specified for the feature. | | ||
| - | | pointStyle | [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]<!-- ThinkGeo.MapSuite.Core.PointStyle --> | This parameter is the style you want to draw with if the value matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ValueItem(String, TextStyle) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify a TextStyle you want to use. You should use this if the features you are drawing are text based. Alternatively, you can set the properties of the DefaultTextSytle directly on 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 DefaultTextStyle. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | value | String<!-- System.String --> | This parameter is the value that will match with the data specified for the feature. | | ||
| - | | textStyle | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.Core.TextStyle --> | This parameter is the style you want to draw with if the value matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ValueItem(String, Collection<Style>) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify a group of CustomStyles you want to use. You can add the potential AreaStyle, LineStyle, or PointStyle to the CustomStyles to draw areas, lines and points separately. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | value | String<!-- System.String --> | This parameter is the value that will match with the data specified for the feature. | | ||
| - | | customStyles | Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Style} --> | This parameter represents the styles you want to draw with if the value matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#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]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Style} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ValueItem --> | ||
| - | [[#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 === | ||
| - | 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 Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.Core.AreaStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ValueItem --> | ||
| - | [[#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 === | ||
| - | 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 Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]<!-- ThinkGeo.MapSuite.Core.LineStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ValueItem --> | ||
| - | [[#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 === | ||
| - | 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 Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]<!-- ThinkGeo.MapSuite.Core.PointStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ValueItem --> | ||
| - | [[#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 === | ||
| - | 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 Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.Core.TextStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ValueItem --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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. | ||
| - | === 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ValueItem --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.Core]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.core.valueitem.1440040130.txt.gz ยท Last modified: 2015/09/17 10:41 (external edit)
