This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mvcedition.valuemarkerstyle [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.mvcedition.valuemarkerstyle [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.MvcEdition.ValueMarkerStyle ====== | ====== ThinkGeo.MapSuite.MvcEdition.ValueMarkerStyle ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class allows you to match a value with data in the feature to determine how to draw the feature. | This class allows you to match a value with data in the feature to determine how to draw the feature. | ||
| - | === Remarks === | ||
| - | ValueMarkerStyle: | ||
| - | |||
| - | The ValueMarkerStyle allows you to match data in the FeatureSource with a value string. If the value matches, then we will use the style defined in that item to create the markers. | ||
| - | |||
| - | For example, you may have some data about cities, with each city categorized as either a high, medium or low pollution city. Based on the string values of "High", "Medium" and "Low", we can match on these. If a particular feature's data for the column matched "High", then we would use the high MarkerValueItem's style to create that city's marker. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.MvcEdition.MarkerStyle]] | + | *ThinkGeo.MapSuite.MvcEdition.MarkerStyle |
| - | ***[[ThinkGeo.MapSuite.MvcEdition.ValueMarkerStyle]] | + | ***ThinkGeo.MapSuite.MvcEdition.ValueMarkerStyle** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ValueMarkerStyle() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueMarkerStyle()|ValueMarkerStyle]] | | | Initialize a new instance of the ValueMarkerStyle class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueMarkerStyle(String)|ValueMarkerStyle]] | String | | Initialize a new instance of the ValueMarkerStyle class with the columnName specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueMarkerStyle(String, Collection<MarkerValueItem>)|ValueMarkerStyle]] | String, Collection<[[ThinkGeo.MapSuite.MvcEdition.MarkerValueItem|MarkerValueItem]]> | | Initialize a new instance of the ValueMarkerStyle class with the columnName and a collection of valueItems specified. | | + | |
| - | ==== Protected Constructors ==== | + | * //Initialize a new instance of the ValueMarkerStyle class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //N/A// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ValueMarkerStyle(String) ** | ||
| + | * //Initialize a new instance of the ValueMarkerStyle class with the columnName specified.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Parameters == | ||
| + | * //columnName// | ||
| + | * Type:String | ||
| + | * Description:The column name used to match with the value specified in the items. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ValueMarkerStyle(String,Collection<MarkerValueItem>) ** | ||
| + | |||
| + | * //Initialize a new instance of the ValueMarkerStyle class with the columnName and a collection of valueItems specified.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Parameters == | ||
| + | * //columnName// | ||
| + | * Type:String | ||
| + | * Description:The column name used to match with the value specified in the items. | ||
| + | |||
| + | * //valueItems// | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.MvcEdition.MarkerValueItem|MarkerValueItem]]> | ||
| + | * Description:A collection of valueItems that defines the style applied to markers. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetMarkers(IEnumerable<Feature>) ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetMarkers(IEnumerable<Feature>)|GetMarkers]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]](overriden) | Returns a collection of markers with a style applied based on the features that are passed in. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //Returns a collection of markers with a style applied based on the features that are passed in.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //N/A// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetContextMenusCore()|GetContextMenusCore]] | | [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]](overriden) | Gets a collection of context menus that are associated with the MarkerStyle. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.MvcEdition.Marker|Marker]]> |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ColumnName|ColumnName]] | String | | Gets or sets the column name used to match with the value specified in the items. | | + | * Description:A collection of markers with a style applied based on the features that are passed in. |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ValueItems|ValueItems]] | Collection<[[ThinkGeo.MapSuite.MvcEdition.MarkerValueItem|MarkerValueItem]]> | | Gets the collection of ValueItems. Each item can have a value to match. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * //features// |
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:A collection of features used to create the markers. | ||
| - | ==== Public Events ==== | + | <div newline></div> |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | ===== Public Constructors ===== | + | * //N/A// |
| - | ==== ValueMarkerStyle() ==== | + | == Remarks == |
| - | Initialize a new instance of the ValueMarkerStyle class. | + | * //N/A// |
| - | === Overloads === | + | |
| - | Initialize a new instance of the ValueMarkerStyle class. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ==== ValueMarkerStyle(String) ==== | + | * Type:String |
| - | Initialize a new instance of the ValueMarkerStyle class with the columnName specified. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | Initialize a new instance of the ValueMarkerStyle class. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | columnName | String<!-- System.String --> | The column name used to match with the value specified in the items. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== ValueMarkerStyle(String, Collection<MarkerValueItem>) ==== | + | <div newline></div> |
| - | Initialize a new instance of the ValueMarkerStyle class with the columnName and a collection of valueItems specified. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | === Overloads === | + | |
| - | Initialize a new instance of the ValueMarkerStyle class. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | columnName | String<!-- System.String --> | The column name used to match with the value specified in the items. | | + | |
| - | | valueItems | Collection<[[ThinkGeo.MapSuite.MvcEdition.MarkerValueItem|MarkerValueItem]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.MarkerValueItem} --> | A collection of valueItems that defines the style applied to markers. | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //N/A// |
| - | ===== Protected Constructors ===== | + | == Remarks == |
| - | ===== Public Methods ===== | + | * //N/A// |
| - | ==== Equals(Object) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Boolean |
| - | | obj | Object<!-- System.Object --> | | | + | * Description:N/A |
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //obj// |
| - | ==== GetHashCode() ==== | + | * Type:Object |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetMarkers(IEnumerable<Feature>) ==== | + | * //N/A// |
| - | Returns a collection of markers with a style applied based on the features that are passed in. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.MvcEdition.Marker|Marker]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.Marker} --> | A collection of markers with a style applied based on the features that are passed in. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| - | | features | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> | A collection of features used to create the markers. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.MvcEdition.MarkerStyle(overriden) --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== GetType() ==== | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Type |
| - | ==== ToString() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ==== Protected Methods ==== | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetContextMenusCore() ** | ||
| - | <!-- System.Object --> | + | * //Gets a collection of context menus that are associated with the MarkerStyle.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ===== Protected Methods ===== | + | * //N/A// |
| - | ==== Finalize() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection<T>[[ThinkGeo.MapSuite.MvcEdition.ContextMenu, MvcEdition, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoKeyedCollection<T>]] |
| + | * Description:A collection of context menus that are associated with the MarkerStyle. | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ==== GetContextMenusCore() ==== | + | ** {{wiki:ProtectedMethod.gif|}} LxU=() ** |
| - | Gets a collection of context menus that are associated with the MarkerStyle. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection|GeoKeyedCollection]]<[[ThinkGeo.MapSuite.MvcEdition.ContextMenu|ContextMenu]]><!-- ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection{ThinkGeo.MapSuite.MvcEdition.ContextMenu} --> | A collection of context menus that are associated with the MarkerStyle. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.MarkerStyle(overriden) --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection<T>[[ThinkGeo.MapSuite.MvcEdition.ContextMenu, MvcEdition, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoKeyedCollection<T>]] |
| - | ==== MemberwiseClone() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ===== Public Properties ===== | + | * //N/A// |
| - | ==== ColumnName ==== | + | |
| - | Gets or sets the column name used to match with the value specified in the items. | + | == Return Value == |
| - | === Remarks === | + | * Type:Void |
| - | This is the column whose values we will use for matching. | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | == Parameters == |
| - | | String<!-- System.String --> | | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} ValueItems ** | ||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ValueMarkerStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ValueItems ==== | ||
| Gets the collection of ValueItems. Each item can have a value to match. | Gets the collection of ValueItems. Each item can have a value to match. | ||
| - | === Remarks === | + | == Remarks == |
| You will want to add MarkerValueItems to this collection. Each item can have its own style and matching string. | You will want to add MarkerValueItems to this collection. Each item can have its own style and matching string. | ||
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.MvcEdition.MarkerValueItem|MarkerValueItem]]> |
| - | | Collection<[[ThinkGeo.MapSuite.MvcEdition.MarkerValueItem|MarkerValueItem]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.MarkerValueItem} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ValueMarkerStyle --> | + | ** {{wiki:PublicProperty.gif|}} ColumnName ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | Gets or sets the column name used to match with the value specified in the items. |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | This is the column whose values we will use for matching. |
| - | [[Category:MvcEdition]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.MvcEdition]] | + | * Type:String |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||