ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.Core.ClassBreakStyle ======
This class represents a style based on class break values.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.Core.Style
      ***ThinkGeo.MapSuite.Core.ClassBreakStyle**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} ClassBreakStyle() **

This is the constructor for this class.
== Remarks ==
N/A
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} ClassBreakStyle(String) **

This is the constructor for this class.
== Remarks ==
N/A
== Parameters ==
  * //columnName//
    * Type:String
    * Description:This parameter is the column name of the column that will be used for the break values.

<div newline></div>
** {{wiki:PublicMethod.gif|}} ClassBreakStyle(String,BreakValueInclusion) **

This is the constructor for this class.
== Remarks ==
N/A
== Parameters ==
  * //columnName//
    * Type:String
    * Description:This parameter is the column name of the column that will be used for the break values.

  * //breakValueInclusion//
    * Type:[[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]]
    * Description:This parameter lets you specify whether the break value is included in the class break calculation.

<div newline></div>
** {{wiki:PublicMethod.gif|}} ClassBreakStyle(String,BreakValueInclusion,Collection<ClassBreak>) **

This is the constructor for this class.
== Remarks ==
N/A
== Parameters ==
  * //columnName//
    * Type:String
    * Description:This parameter is the column name of the column that will be used for the break values.

  * //breakValueInclusion//
    * Type:[[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]]
    * Description:This parameter lets you specify whether the break value is included in the class break calculation.

  * //classBreaks//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.ClassBreak|ClassBreak]]>
    * Description: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.

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} CloneDeep() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //features//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
    * Description:N/A

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //shapes//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>
    * Description:N/A

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Collection<String>
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} DrawSample(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:PublicMethod.gif|}} DrawSample(GeoCanvas) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} SaveStyle(String) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //filePathName//
    * Type:String
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //stream//
    * Type:Stream
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} OnGottenFeatureValue(GottenFeatureValueClassBreakStyleEventArgs) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.Core.GottenFeatureValueClassBreakStyleEventArgs|GottenFeatureValueClassBreakStyleEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 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 ==
  * Type:Void
  * Description:None

== Parameters ==
  * //features//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
    * Description:This parameter represents the features you want to draw on the canvas.

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:This parameter represents the canvas you want to draw the features on.

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:The labels will be drawn in the current layer only.

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:The labels will be drawn in all layers.

<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|}} 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 ==
  * Type:Collection<String>
  * Description:This method returns a collection of the column names that it needs.

== Parameters ==
<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 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 ==
  * Type:String

** {{wiki:PublicProperty.gif|}} 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 ==
  * Type:[[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]]

** {{wiki:PublicProperty.gif|}} 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 ==
  * Type:Collection<[[ThinkGeo.MapSuite.Core.ClassBreak|ClassBreak]]>

** {{wiki:PublicProperty.gif|}} Name **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:String

** {{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 ====
** {{wiki:PublicEvent.gif|}} GottenFeatureValue **
N/A
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.Core.GottenFeatureValueClassBreakStyleEventArgs|GottenFeatureValueClassBreakStyleEventArgs]]
User Tools

Site Tools

Page Tools
