thinkgeo.mapsuite.core.classbreakstyle
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.classbreakstyle [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.ClassBreakStyle ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class represents a style based on class break values. | ||
| - | === Remarks === | ||
| - | The ClassBreakStyle allows you to change the way features are drawn based on their data values. It is often useful for you to display features differently based on ranges of numeric values. For example, you may have a states ShapeFile that has the populations of each state as part of its data. You may then want to color states differently based on their population. The ClassBreakStyle allows you to do this. | ||
| - | |||
| - | How class breaks work: | ||
| - | |||
| - | You add a number of ClassBreak classes to the ClassBreak collection. The numeric values of the breaks are important and you must place the breaks in numerical order. For example, break 0 must be added before break 100. In each ClassBreak, you specify the style you want to represent that break. Additionally, in the ColumnName property, you specify the name of the column where we will find the data used to compare the breaks. The column name must point to a column that is numeric. | ||
| - | |||
| - | When we proceed to draw the style, we look through the ClassBreaks and select the ClassBreak that is where the features column data is greater than and closest to the break value. | ||
| - | |||
| - | Example: | ||
| - | |||
| - | Feature Value = 42 | ||
| - | |||
| - | ClassBreak1.Value = 0 | ||
| - | ClassBreak2.Value = 20 | ||
| - | ClassBreak3.Value = 40 | ||
| - | ClassBreak4.Value = 60 | ||
| - | |||
| - | In this case, the break closest to the feature value without exceeding it is ClassBreak3(40). If the feature value had been less than zero, nothing would have been drawn. If the feature value were 1000, then ClassBreak4 would draw. | ||
| - | |||
| - | If you wanted to represent a value that is less then zero, you could do that as shown in the sample below. | ||
| - | |||
| - | Feature Value = -1 | ||
| - | |||
| - | ClassBreak1.Value = Double.Min | ||
| - | ClassBreak2.Value = 0 | ||
| - | ClassBreak3.Value = 20 | ||
| - | ClassBreak4.Value = 40 | ||
| - | |||
| - | In this example, the first class break would be used. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.Core.Style]] | ||
| - | ***[[ThinkGeo.MapSuite.Core.ClassBreakStyle]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreakStyle()|ClassBreakStyle]] | | | This is the constructor for this class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreakStyle(String)|ClassBreakStyle]] | String | | This is the constructor for this class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreakStyle(String, BreakValueInclusion)|ClassBreakStyle]] | String, [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]] | | This is the constructor for this class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreakStyle(String, BreakValueInclusion, Collection<ClassBreak>)|ClassBreakStyle]] | String, [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]], Collection<[[ThinkGeo.MapSuite.Core.ClassBreak|ClassBreak]]> | | This is the constructor for this class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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<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}}[[#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}}[[#DrawSample(GeoCanvas)|DrawSample]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | | {{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}}[[#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(Stream)|LoadStyle]] | Stream | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadStyle(Uri)|LoadStyle]] | Uri | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SaveStyle(Stream)|SaveStyle]] | 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}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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. | | ||
| - | | {{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 | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnGottenFeatureValue(GottenFeatureValueClassBreakStyleEventArgs)|OnGottenFeatureValue]] | [[ThinkGeo.MapSuite.Core.GottenFeatureValueClassBreakStyleEventArgs|GottenFeatureValueClassBreakStyleEventArgs]] | | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BreakValueInclusion|BreakValueInclusion]] | [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]] | | This property gets and sets the value of if the break values are included in the break calculation. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ClassBreaks|ClassBreaks]] | Collection<[[ThinkGeo.MapSuite.Core.ClassBreak|ClassBreak]]> | | This property gets the collection of class breaks. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ColumnName|ColumnName]] | String | | This property gets and sets the column name in the FeatureSource where the data will be found for each feature. | | ||
| - | | {{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. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#FiltersCore|FiltersCore]] | Collection<String> | [[ThinkGeo.MapSuite.Core.Style|Style]] | | | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#GottenFeatureValue|GottenFeatureValue]] | [[ThinkGeo.MapSuite.Core.GottenFeatureValueClassBreakStyleEventArgs|GottenFeatureValueClassBreakStyleEventArgs]] | | | | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== ClassBreakStyle() ==== | ||
| - | This is the constructor for this class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ClassBreakStyle(String) ==== | ||
| - | This is the constructor for this class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify the column name of the column that will be used for the break values. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | columnName | String<!-- System.String --> | This parameter is the column name of the column that will be used for the break values. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ClassBreakStyle(String, BreakValueInclusion) ==== | ||
| - | This is the constructor for this class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify the column name of the column that will be used for the break values. It also lets you specify whether the break value is included in the class break calculation. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | columnName | String<!-- System.String --> | This parameter is the column name of the column that will be used for the break values. | | ||
| - | | breakValueInclusion | [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]]<!-- ThinkGeo.MapSuite.Core.BreakValueInclusion --> | This parameter lets you specify whether the break value is included in the class break calculation. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ClassBreakStyle(String, BreakValueInclusion, Collection<ClassBreak>) ==== | ||
| - | This is the constructor for this class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify the column name of the column that will be used for the break values. It also lets you specify whether the break value is included in the class break calculation. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | columnName | String<!-- System.String --> | This parameter is the column name of the column that will be used for the break values. | | ||
| - | | breakValueInclusion | [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]]<!-- ThinkGeo.MapSuite.Core.BreakValueInclusion --> | This parameter lets you specify whether the break value is included in the class break calculation. | | ||
| - | | classBreaks | Collection<[[ThinkGeo.MapSuite.Core.ClassBreak|ClassBreak]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.ClassBreak} --> | The parameter represents the class break that will determine which style to be used on the break values. Please see the ClassBreakStyle class remarks for a full description of how the ClassBreakStyle works. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | ||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | 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 --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | ||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | 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. | | ||
| - | | 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 --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== DrawSample(GeoCanvas) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== DrawSample(GeoCanvas, DrawingRectangleF) ==== | ||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | 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 --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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]] | ||
| - | ==== GetRequiredColumnNames() ==== | ||
| - | 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. | ||
| - | |||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns a collection of column names that the style needs. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== LoadStyle(Stream) ==== | ||
| - | <!-- static --> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | styleStream | Stream<!-- System.IO.Stream --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== LoadStyle(Uri) ==== | ||
| - | <!-- static --> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | styleUri | Uri<!-- System.Uri --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== SaveStyle(Stream) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | stream | Stream<!-- System.IO.Stream --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== SaveStyle(String) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | filePathName | String<!-- System.String --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#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 ===== | ||
| - | ==== 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ==== | ||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | 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) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawSampleCore(GeoCanvas, DrawingRectangleF) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | ||
| - | | drawingExtent | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.Core.DrawingRectangleF --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetRequiredColumnNamesCore() ==== | ||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns a collection of the column names that it needs. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnGottenFeatureValue(GottenFeatureValueClassBreakStyleEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.Core.GottenFeatureValueClassBreakStyleEventArgs|GottenFeatureValueClassBreakStyleEventArgs]]<!-- ThinkGeo.MapSuite.Core.GottenFeatureValueClassBreakStyleEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ClassBreakStyle --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== BreakValueInclusion ==== | ||
| - | This property gets and sets the value of if the break values are included in the break calculation. | ||
| - | === Remarks === | ||
| - | Example: If you have a class break value set to 100 and the break value is included, then 100 is included for this break. If you set the value to excluded, then 100 would match with the break below 100 instead. | ||
| - | |||
| - | Please see the ClassBreakStyle class remarks for a full description of how the ClassBreakStyle works. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]]<!-- ThinkGeo.MapSuite.Core.BreakValueInclusion --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ClassBreakStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ClassBreaks ==== | ||
| - | This property gets the collection of class breaks. | ||
| - | === Remarks === | ||
| - | The class breaks determine which style to use, based on the break values. | ||
| - | |||
| - | Please see the ClassBreakStyle class remarks for a full description of how the ClassBreakStyle works. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.Core.ClassBreak|ClassBreak]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.ClassBreak} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ClassBreakStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ColumnName ==== | ||
| - | This property gets and sets the column name in the FeatureSource where the data will be found for each feature. | ||
| - | === Remarks === | ||
| - | You use this property to set the name of the column where the numeric data is stored for your features. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ClassBreakStyle --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Filters ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsActive ==== | ||
| - | 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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RequiredColumnNames ==== | ||
| - | This property gets the collection of fields that are required for the style. | ||
| - | === Remarks === | ||
| - | 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ==== FiltersCore ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.Style --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | ==== GottenFeatureValue ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.GottenFeatureValueClassBreakStyleEventArgs|GottenFeatureValueClassBreakStyleEventArgs]]<!-- ThinkGeo.MapSuite.Core.GottenFeatureValueClassBreakStyleEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.ClassBreakStyle --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | |||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.Core]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.core.classbreakstyle.1440040128.txt.gz ยท Last modified: 2015/09/17 08:56 (external edit)
