thinkgeo.mapsuite.core.valuestyle
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.valuestyle [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.core.valuestyle [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.ValueStyle ====== | ====== ThinkGeo.MapSuite.Core.ValueStyle ====== | ||
| + | {{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 that feature. | This class allows you to match a value with data in the feature to determine how to draw that feature. | ||
| - | === 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 ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.Core.Style]] | + | *ThinkGeo.MapSuite.Core.Style |
| - | ***[[ThinkGeo.MapSuite.Core.ValueStyle]] | + | ***ThinkGeo.MapSuite.Core.ValueStyle** |
| - | ****[[ThinkGeo.MapSuite.Core.NoaaWeatherWarningsStyle]] | + | *[[ThinkGeo.MapSuite.Core.NoaaWeatherWarningsStyle]] |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ValueStyle() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueStyle()|ValueStyle]] | | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ValueStyle(String, Collection<ValueItem>)|ValueStyle]] | String, Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]> | | This is a constructor for this class. | | + | |
| - | ==== Protected Constructors ==== | + | * //This is a constructor for the class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //If you use this constructor, you need to set the required properties manually.// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ValueStyle(String,Collection<ValueItem>) ** | ||
| + | * //This is a constructor for this class.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Parameters == | ||
| + | * //columnName// | ||
| + | * Type:String | ||
| + | * Description:The columnName used to match with the value specified in the items. | ||
| + | |||
| + | * //valueItems// | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]> | ||
| + | * Description:The collection of ValueItems. Each item can have its own value to match. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | Create a copy of style using the deep clone process. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|Draw]] | IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method draws the shapes on the canvas you provided. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|Draw]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method draws the features on the canvas you provided. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas, DrawingRectangleF)|DrawSample]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method draws a sample feature on the canvas you provided. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas)|DrawSample]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRequiredColumnNames()|GetRequiredColumnNames]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | This method returns the column data for each feature that is required for the style to properly draw. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadStyle(Uri)|LoadStyle]] | Uri | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadStyle(Stream)|LoadStyle]] | Stream | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SaveStyle(String)|SaveStyle]] | String | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SaveStyle(Stream)|SaveStyle]] | Stream | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //N/A// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.Core.Style|Style]] | Create a copy of style using the deep clone process. The default implementation method uses serialization. | | + | * //N/A// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|DrawCore]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Style|Style]](overriden) | This method draws the features on the canvas you provided. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawSampleCore(GeoCanvas, DrawingRectangleF)|DrawSampleCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | [[ThinkGeo.MapSuite.Core.Style|Style]](overriden) | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]] | | [[ThinkGeo.MapSuite.Core.Style|Style]](overriden) | This method returns the column data for each feature that is required for the style to properly draw. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:[[ThinkGeo.MapSuite.Core.Style|Style]] |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ColumnName|ColumnName]] | String | | This property gets and sets the column name used to match with the value specified in the items. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Filters|Filters]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsActive|IsActive]] | Boolean | [[ThinkGeo.MapSuite.Core.Style|Style]] | This property gets and sets the active status of the style. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.Core.Style|Style]] | This property gets and set the name of the style. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RequiredColumnNames|RequiredColumnNames]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | This property gets the collection of fields that are required for the style. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ValueItems|ValueItems]] | Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]> | | This property gets the collection of ValueItems. Each item can have its own value to match. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#FiltersCore|FiltersCore]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | ==== Public Events ==== | + | * //N/A// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== ValueStyle() ==== | + | * Type:Void |
| - | This is a constructor for the class. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | This is the default constructor. If you use this constructor, you need to set the required properties manually. | + | |
| - | === Remarks === | + | |
| - | If you use this constructor, you need to set the required properties manually. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== ValueStyle(String, Collection<ValueItem>) ==== | + | * //features// |
| - | This is a constructor for this class. | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | === Parameters === | + | * Description:N/A |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | columnName | String<!-- System.String --> | The columnName used to match with the value specified in the items. | | + | |
| - | | valueItems | Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.ValueItem} --> | The collection of ValueItems. Each item can have its own value to match. | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //canvas// |
| - | ===== Protected Constructors ===== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | ===== Public Methods ===== | + | * Description:N/A |
| - | ==== CloneDeep() ==== | + | |
| - | Create a copy of style using the deep clone process. | + | |
| - | === Remarks === | + | |
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | A cloned style. | | + | |
| - | === Parameters === | + | * //labelsInThisLayer// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //labelsInAllLayers// |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | ==== Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | + | * Description:N/A |
| - | This method draws the shapes on the canvas you provided. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method DrawCore. In this method, we take the shapes you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each shape differently. | + | |
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | shapes | IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.BaseShape} --> | This parameter represents the shapes you want to draw on the canvas. | | + | * //N/A// |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the shapes on. | | + | |
| - | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | + | |
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in all layers. | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | + | * Description:N/A |
| - | This method draws the features on the canvas you provided. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method DrawCore. 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. | + | |
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Parameters == |
| - | === Return Value === | + | * //shapes// |
| - | ^ Return Type ^ Description ^ | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> |
| - | | Void<!-- System.Void --> | | | + | * Description:N/A |
| - | === Parameters === | + | * //canvas// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | | features | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> | This parameter represents the features you want to draw on the canvas. | | + | * Description:N/A |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | + | |
| - | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | + | |
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in all layers. | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //labelsInThisLayer// |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | ==== DrawSample(GeoCanvas, DrawingRectangleF) ==== | + | * Description:N/A |
| - | This method draws a sample feature on the canvas you provided. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method DrawSampleCore. In this method we draw a sample style on the canvas you provided. This is typically used to display a legend or other sample area. | + | |
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //labelsInAllLayers// |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | + | |
| - | | drawingExtent | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.Core.DrawingRectangleF --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== DrawSample(GeoCanvas) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<String> |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== Equals(Object) ==== | + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | obj | Object<!-- System.Object --> | | | + | * //N/A// |
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== GetHashCode() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //canvas// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | * //drawingExtent// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] |
| - | ==== GetRequiredColumnNames() ==== | + | * Description:N/A |
| - | This method returns the column data for each feature that is required for the style to properly draw. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method GetRequiredColumnNamesCore. 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. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns a collection of column names that the style needs. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //canvas// |
| - | ==== GetType() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== LoadStyle(Uri) ==== | + | * //N/A// |
| - | <!-- static --> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | styleUri | Uri<!-- System.Uri --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //filePathName// |
| - | ==== LoadStyle(Stream) ==== | + | * Type:String |
| - | <!-- static --> | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** |
| - | | styleStream | Stream<!-- System.IO.Stream --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== SaveStyle(String) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | filePathName | String<!-- System.String --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //stream// |
| - | ==== SaveStyle(Stream) ==== | + | * Type:Stream |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | | stream | Stream<!-- System.IO.Stream --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== ToString() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ===== Protected Methods ===== | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | ==== CloneDeepCore() ==== | + | |
| - | Create a copy of style using the deep clone process. The default implementation method uses serialization. | + | |
| - | === Remarks === | + | |
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | A cloned style. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Boolean |
| - | ==== DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | + | * Description:N/A |
| - | This method draws the features on the canvas you provided. | + | |
| - | === 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. | + | == Parameters == |
| - | === Return Value === | + | * //obj// |
| - | ^ Return Type ^ Description ^ | + | * Type:Object |
| - | | Void<!-- System.Void --> | | | + | * Description:N/A |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | | features | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> | This parameter represents the features you want to draw on the canvas. | | + | |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter represents the canvas you want to draw the features on. | | + | |
| - | | labelsInThisLayer | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in the current layer only. | | + | |
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | The labels will be drawn in all layers. | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style(overriden) --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== DrawSampleCore(GeoCanvas, DrawingRectangleF) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | + | * Description:N/A |
| - | | drawingExtent | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.Core.DrawingRectangleF --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style(overriden) --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ==== Finalize() ==== | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Type |
| - | ==== GetRequiredColumnNamesCore() ==== | + | * Description:N/A |
| - | This method returns the column data for each feature that is required for the style to properly draw. | + | |
| - | === 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. | + | == Parameters == |
| - | === Return Value === | + | <div newline></div> |
| - | ^ Return Type ^ Description ^ | + | ==== Protected Methods ==== |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns a collection of the column names that it needs. | | + | ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** |
| - | === Parameters === | + | * //This method draws the features on the canvas you provided.// |
| - | ^ Name ^ Type ^ Description ^ | + | == 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.// | ||
| - | <!-- ThinkGeo.MapSuite.Core.Style(overriden) --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== MemberwiseClone() ==== | + | * Description:None |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //features// |
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This parameter represents the features you want to draw on the canvas. | ||
| - | <!-- System.Object --> | + | * //canvas// |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | ===== Public Properties ===== | + | * Description:This parameter represents the canvas you want to draw the features on. |
| - | ==== ColumnName ==== | + | |
| - | This property gets and sets the column name used to match with the value specified in the items. | + | |
| - | === Remarks === | + | |
| - | This is the column we use for matching. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.ValueStyle --> | + | * //labelsInThisLayer// |
| - | [[#Public Properties|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | ==== Filters ==== | + | * Description:The labels will be drawn in the current layer only. |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //labelsInAllLayers// |
| - | [[#Public Properties|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | ==== IsActive ==== | + | * Description:The labels will be drawn in all layers. |
| - | This property gets and sets the active status of the style. | + | |
| - | === Remarks === | + | |
| - | If the style is not active then it will not draw. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | <div newline></div> |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** |
| - | ==== Name ==== | + | |
| - | This property gets and set the name of the style. | + | |
| - | === Remarks === | + | |
| - | This name is not used by the system; it is only for the developer. However, it can be used if you generate your own legend. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | * //This method returns the column data for each feature that is required for the style to properly draw.// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== RequiredColumnNames ==== | + | * //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 property gets the collection of fields that are required for the style. | + | |
| - | === Remarks === | + | == Return Value == |
| - | This property gets the collection of fields that are required for the style. These are in addition to any other columns you specify in styles that inherit from this one. For example, if you have use a ValueStyle and it requires a column name for the value comparison, then that column does not need to be in this collection. You only use the RequiredColumnNames for columns you need beyond those required by specific inherited styles. | + | * Type:Collection<String> |
| - | === Return Value === | + | * Description:This method returns a collection of the column names that it needs. |
| - | ^ Return Type ^ | + | |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //canvas// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //drawingExtent// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Style|Style]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <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|}} ColumnName ** | ||
| + | |||
| + | This property gets and sets the column name used to match with the value specified in the items. | ||
| + | == Remarks == | ||
| + | This is the column we use for matching. | ||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} ValueItems ** | ||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ValueItems ==== | ||
| This property gets the collection of ValueItems. Each item can have its own value to match. | This property gets the collection of ValueItems. Each item can have its own value to match. | ||
| - | === Remarks === | + | == Remarks == |
| You will want to add ValueItems to this collection. Each item can have its own style and matching string. | You will want to add ValueItems to this collection. Each item can have its own style and matching string. | ||
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]> |
| - | | Collection<[[ThinkGeo.MapSuite.Core.ValueItem|ValueItem]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.ValueItem} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.ValueStyle --> | + | ** {{wiki:PublicProperty.gif|}} Name ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | |
| - | ==== FiltersCore ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | + | N/A |
| - | [[#Protected Properties|Go Back]] | + | == Remarks == |
| - | ===== Public Events ===== | + | N/A |
| - | __NOTOC__ | + | == Return Value == |
| - | [[Category:MapSuiteCore]] | + | * Type:String |
| - | [[Category:ThinkGeo.MapSuite.Core]] | + | |
| - | [[Category:UpdateDocumentation]] | + | ** {{wiki:PublicProperty.gif|}} IsActive ** |
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Collection<String> | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Filters ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Collection<String> | ||
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Collection<String> | ||
| + | |||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.core.valuestyle.1440040130.txt.gz · Last modified: 2015/09/17 10:41 (external edit)