User Tools

Site Tools

Trace:
thinkgeo.mapsuite.core.zoomlevel

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.core.zoomlevel [2015/08/20 03:08]
127.0.0.1 external edit 		thinkgeo.mapsuite.core.zoomlevel [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.Core.ZoomLevel ====== ====== ThinkGeo.MapSuite.Core.ZoomLevel ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 This class defines how InternalFeatures will be drawn based on their scale. This class defines how InternalFeatures will be drawn based on their scale.
-=== Remarks === 
-This class defines how InternalFeatures will be drawn based on their scale. Inside of the ZoomLevelSet there are a number of zoom levels. We will determine which ZoomLevel to use based on which one has the Scale property closest to the current scale. The matching one will define the styles that will be used to draw the InternalFeatures on the map. 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.Core.ZoomLevel]]+    ***ThinkGeo.MapSuite.Core.ZoomLevel**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} ZoomLevel() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#ZoomLevel()|ZoomLevel]] ​  ​| ​   |    | This is a constructor for the class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ZoomLevel(Double)|ZoomLevel]] ​  | Double ​  ​| ​   | This is a constructor for the class. ​  |+
  
-==== Protected Constructors ​==== +  * //This is a constructor for the class.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //This is the default constructor. If you use this constructor,​ you should set the require properties on the class manually.//​ 
 +== Parameters ​== 
 +<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} ZoomLevel(Double) **
  
 +  * //This is a constructor for the class.//
 +== Remarks ==
 +  * //This constructor allows you to provide the scale for this ZoomLevel.//​
 +== Parameters ==
 +  * //scale//
 +    * Type:Double
 +    * Description:​This paramter is the scale for the ZoomLevel.
 +
 +<div newline></​div>​
 +==== Protected Constructors ====
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} GetRequiredColumnNames() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Draw(GeoCanvas,​ IEnumerable<​Feature>,​ Collection<​SimpleCandidate>,​ Collection<​SimpleCandidate>​)|Draw]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​ IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>,​ Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,​ Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> ​  ​| ​   | This method draws the ZoomLevel. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Draw(GeoCanvas,​ IEnumerable<​BaseShape>,​ Collection<​SimpleCandidate>,​ Collection<​SimpleCandidate>​)|Draw]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​ IEnumerable<​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>,​ Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,​ Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> ​  ​| ​   | This method draws the ZoomLevel. ​  | +
-| {{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]] ​  ​| ​   |    | This method returns the column data for each feature that is required for the styles to properly draw.   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Protected Methods ==== +  * //This method returns the column data for each feature that is required for the styles to properly draw.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +== Remarks ​== 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​DrawCore(GeoCanvas, IEnumerable<​Feature>​, Collection<​SimpleCandidate>,​ Collection<​SimpleCandidate>​)|DrawCore]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​, Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​, Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> ​  ​| ​   | This method draws the ZoomLevel.   | +  * //In this method, we return the column names that are required for the styles 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 the 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.//
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Public Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * Type:​Collection<​String> 
-| {{wiki:PublicProperty.gif|Public Property}}[[#​ApplyUntilZoomLevel|ApplyUntilZoomLevel]] ​  | [[ThinkGeo.MapSuite.Core.ApplyUntilZoomLevel|ApplyUntilZoomLevel]] ​  ​| ​   | This property gets and sets the zoom to which we will use this zoom level'​s styles. ​  | +  * Description:​This method returns ​a collection ​containing ​the required column names.
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​CustomStyles|CustomStyles]] ​  ​| ​Collection<​[[ThinkGeo.MapSuite.Core.Style|Style]]>   |    | This property gets a collection ​of custom styles used to draw.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​DefaultAreaStyle|DefaultAreaStyle]] ​  | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] ​  ​| ​   | This property gets and sets the default AreaStyle used to draw.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​DefaultLineStyle|DefaultLineStyle]] ​  | [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] ​  ​| ​   | This property gets and sets the default LineStyle used to draw.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​DefaultPointStyle|DefaultPointStyle]] ​  | [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]] ​  ​| ​   | This property gets and sets the default PointStyle used to draw.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​DefaultTextStyle|DefaultTextStyle]] ​  | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] ​  ​| ​   | This property gets and sets the default TextStyle used to draw.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsActive|IsActive]] ​  | Boolean ​  ​| ​   | This property gets and sets whether the ZoomLevel is active and should draw.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Name|Name]] ​  | String ​  ​| ​   | This property gets and sets the name for the ZoomLevel. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Scale|Scale]] ​  | Double ​  ​| ​   | This property gets and sets the scale for the ZoomLevel.   |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} Draw(GeoCanvas,​IEnumerable<​Feature>,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
  
-==== Public Events ==== +  * //This method draws the ZoomLevel.//​ 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the Layer based on the extent you provided. 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.//​
  
-===== Public Constructors ===== +== Return Value == 
-==== ZoomLevel() ==== +  ​* Type:Void 
-This is a constructor for the class. +  * Description:None
-=== Overloads === +
-This is the default constructor. If you use this constructor,​ you should set the require properties on the class manually. +
-=== Remarks === +
-This is the default constructor. If you use this constructor,​ you should set the require properties on the class manually. +
-=== Parameters === +
-^  Name ^  ​Type ​^  ​Description ​^+
  
-[[#Public Constructors|Go Back]] +== Parameters ​== 
-==== ZoomLevel(Double) ​==== +  * //canvas// 
-This is a constructor for the class. +    * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-=== Overloads === +    ​* ​Description:This parameter ​is the Canvas used to draw the InternalFeatures.
-This constructor allows you to provide the scale for this ZoomLevel. +
-=== Remarks === +
-This constructor allows you to provide the scale for this ZoomLevel. +
-=== Parameters === +
-^  Name ^  Type ^  ​Description ​^ +
-| scale   | Double<​!-- System.Double --> ​  ​| ​This paramter ​is the scale for the ZoomLevel.   |+
  
-[[#Public Constructors|Go Back]] +  * //​features//​ 
-===== Protected Constructors ===== +    * Type:​IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]> 
-===== Public Methods ===== +    * Description:​This parameter ​is the collection ​of features that we will draw.
-==== Draw(GeoCanvas,​ IEnumerable<​Feature>,​ Collection<​SimpleCandidate>,​ Collection<​SimpleCandidate>) ==== +
-This method draws the ZoomLevel. +
-=== Remarks === +
-This method ​is the concrete wrapper for the abstract method DrawCore. This method draws the representation ​of the Layer based on the extent you provided.+
  
-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. +  * //​currentLayerLabels//​ 
-=== Return Value === +    * Type:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-^ Return Type ^ Description ​^ +    ​* ​Description:This parameter is the collection of labels in the current layer.
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +  * //​allLayerLabels//​ 
-^  Name ^  ​Type ^  Description ^ +    ​* ​Type:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter is the Canvas used to draw the InternalFeatures. ​  | +    * Description:​This parameter is the collection of labels in all layers.
-| features ​  | IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]><​!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> ​  | This parameter is the collection of features that we will draw.   | +
-| currentLayerLabels ​  ​| ​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​<!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> ​  | This parameter is the collection of labels in the current layer. ​  | +
-| allLayerLabels ​  | Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> ​  ​| ​This parameter is the collection of labels in all layers. ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> +<div newline></​div> 
-[[#Public Methods|Go Back]] +** {{wiki:​PublicMethod.gif|}} Draw(GeoCanvas,​IEnumerable<​BaseShape>,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) ​**
-==== Draw(GeoCanvas,​ IEnumerable<​BaseShape>,​ Collection<​SimpleCandidate>,​ Collection<​SimpleCandidate>​) ​==== +
-This method draws the ZoomLevel. +
-=== Remarks === +
-This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the Layer based on the extent you provided.+
  
-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. +  * //This method draws the ZoomLevel.//​ 
-=== Return Value === +== Remarks == 
-^ Return Type ^ Description ^ +  * //This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the Layer based on the extent you provided. ​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.//
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^ +  ​* Type:Void 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter is the Canvas used to draw the InternalFeatures. ​  | +  * Description:None
-| shapes ​  | IEnumerable<​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]><​!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.BaseShape} --> ​  | This parameter is the collection of shapes that we will draw.   | +
-| currentLayerLabels ​  | Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> ​  | This parameter is the collection of labels in the current layer. ​  | +
-| allLayerLabels ​  | Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> ​  | This parameter is the collection of labels in all layers. ​  |+
  
-<​!-- ​ThinkGeo.MapSuite.Core.ZoomLevel --> +== Parameters == 
-[[#Public Methods|Go Back]] +  * //​canvas//​ 
-==== Equals(Object) ==== +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-=== Return Value === +    ​* ​Description:This parameter is the Canvas used to draw the InternalFeatures.
-^ Return Type ^ Description ​^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +  * //shapes// 
-^  Name ^  ​Type ^  Description ^ +    ​* ​Type:​IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>​ 
-| obj   | Object<!-- System.Object --> ​  |    ​|+    * Description:​This parameter is the collection of shapes that we will draw.
  
-<!-- System.Object --> +  * //​currentLayerLabels//​ 
-[[#Public Methods|Go Back]] +    * Type:​Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> 
-==== GetHashCode() ==== +    ​* ​Description:This parameter is the collection of labels in the current layer.
-=== Return Value === +
-^ Return Type ^ Description ​^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters === +  * //​allLayerLabels//​ 
-^  Name ^  ​Type ^  ​Description ​^+    ​* ​Type:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
 +    * Description:This parameter is the collection of labels in all layers.
  
-<!-- System.Object --> +<div newline></​div> 
-[[#Public Methods|Go Back]] +** {{wiki:​PublicMethod.gif|}} ToString() **
-==== GetRequiredColumnNames() ==== +
-This method returns the column data for each feature that is required for the styles to properly draw. +
-=== Remarks === +
-In this method, we return the column names that are required for the styles 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 the 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. +  * //N/A// 
-=== Return Value === +== Remarks ​== 
-^ Return Type ^ Description ^ +  * //N/A//
-| Collection<​String><​!-- System.Collections.ObjectModel.Collection{System.String} --> ​  | This method returns a collection containing the required column names. ​  |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:String 
 +  * Description:N/A
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== GetType() ​==== +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-=== 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:Boolean 
-==== ToString() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //obj// 
 +    * Type:Object 
 +    * Description:N/A
  
-<!-- System.Object --> +<div newline></div> 
-[[#Public Methods|Go Back]] +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-===== Protected Methods ===== +
-==== DrawCore(GeoCanvas,​ IEnumerable<Feature>, Collection<​SimpleCandidate>,​ Collection<​SimpleCandidate>​) ==== +
-This method draws the ZoomLevel. +
-=== Remarks === +
-This method draws the representation of the Layer based on the extent you provided. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter is the Canvas used to draw the InternalFeatures. ​  | +  ​* //N/A//
-| features ​  | IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]><​!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> ​  | This parameter is the collection of feature that we will draw.   | +
-| currentLayerLabels ​  | Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> ​  | This parameter is the collection of labels in the current layer. ​  | +
-| allLayerLabels ​  | Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> ​  | This parameter is the collection of labels in all layers. ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Int32 
-==== Finalize() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} GetType() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-==== MemberwiseClone() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Type 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +<div newline></​div>​ 
-===== Public Properties ===== +==== Protected Methods ​==== 
-==== ApplyUntilZoomLevel ​==== +** {{wiki:​ProtectedMethod.gif|}} DrawCore(GeoCanvas,IEnumerable<​Feature>​,Collection<​SimpleCandidate>​,Collection<SimpleCandidate>) **
-This property gets and sets the zoom to which we will use this zoom level'​s styles. +
-=== Remarks === +
-This property allows you to apply the current ZoomLevel'​s styles across many ZoomLevels. For example, you may want to display roads as a thin line from ZoomLevel10 through ZoomLevel15. To accomplish this easily, you can set the correct styles on ZoomLevel10 and then set its ApplyUntilZoomLevel property to Level15. This will mean that Level10'​s style will be used until Level15. There is no need to set Level11, Level12, Level13 and so on. +
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.Core.ApplyUntilZoomLevel|ApplyUntilZoomLevel]]<!-- ThinkGeo.MapSuite.Core.ApplyUntilZoomLevel -->   |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> +  * //This method draws the ZoomLevel.// 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== CustomStyles ​==== +  * //This method draws the representation of the Layer based on the extent you provided.// 
-This property gets a collection of custom styles ​used to draw. + 
-=== Remarks === +== Return Value == 
-This is a collection of styles to draw. If you only need to draw one style, then we suggest you do not use this collection ​and instead use one of the default styles, such as DefaultAreaStyle,​ DefaultLineStyle,​ DefaultTextStyle,​ etc. +  * Type:Void 
-=== Return Value === +  * Description:​None 
-^ Return ​Type ^ + 
-| Collection<​[[ThinkGeo.MapSuite.Core.Style|Style]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Style} --> ​  |+== Parameters ​== 
 +  * //​canvas//​ 
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
 +    * Description:​This parameter is the Canvas ​used to draw the InternalFeatures. 
 + 
 +  * //​features//​ 
 +    * Type:​IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​ 
 +    * Description:​This parameter ​is the collection of feature that we will draw. 
 + 
 +  * //​currentLayerLabels//​ 
 +    * Type:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
 +    * Description:​This parameter is the collection of labels in the current layer. 
 + 
 +  * //​allLayerLabels//​ 
 +    * Type:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
 +    * Description:​This parameter is the collection of labels in all layers. 
 + 
 +<div newline></​div>​ 
 +** {{wiki:​ProtectedMethod.gif|}} GetStylesForDrawing() ** 
 + 
 +  * //N/A// 
 +== Remarks == 
 +  * //N/A// 
 + 
 +== Return Value == 
 +  ​* ​Type:​IEnumerable<​[[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|}} IsActive ** 
 + 
 +This property gets and sets whether the ZoomLevel is active and should draw. 
 +== Remarks == 
 +Setting the value to false means that this zoom level will not be considered in the ZoomLevelSet and thus will not draw. 
 +== Return Value == 
 +  * Type:​Boolean 
 + 
 +** {{wiki:​PublicProperty.gif|}} Scale ** 
 + 
 +This property gets and sets the scale for the ZoomLevel. 
 +== Remarks == 
 +The scale 
 +== Return Value == 
 +  * Type:​Double 
 + 
 +** {{wiki:​PublicProperty.gif|}} DefaultAreaStyle **
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> 
-[[#Public Properties|Go Back]] 
-==== DefaultAreaStyle ==== 
 This property gets and sets the default AreaStyle used to draw. This property gets and sets the default AreaStyle used to draw.
-=== Remarks ​=== +== Remarks == 
-If you set this style, then it will be used for drawing.+If you set this style, then it will be used for drawing. ​If you use the default styles, you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle. 
 +== Return Value == 
 +  * Type:​[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
  
-If you use the default styles, you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle. +** {{wiki:​PublicProperty.gif|}} ​DefaultLineStyle ​**
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]<​!-- ThinkGeo.MapSuite.Core.AreaStyle --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> 
-[[#Public Properties|Go Back]] 
-==== DefaultLineStyle ==== 
 This property gets and sets the default LineStyle used to draw. This property gets and sets the default LineStyle used to draw.
-=== Remarks ​=== +== Remarks == 
-If you set this style, then it will be used for drawing.+If you set this style, then it will be used for drawing. ​If you use the default styles, you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle. 
 +== Return Value == 
 +  * Type:​[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
  
-If you use the default styles, you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle. +** {{wiki:​PublicProperty.gif|}} DefaultPointStyle **
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]<​!-- ThinkGeo.MapSuite.Core.LineStyle --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> 
-[[#Public Properties|Go Back]] 
-==== DefaultPointStyle ==== 
 This property gets and sets the default PointStyle used to draw. This property gets and sets the default PointStyle used to draw.
-=== Remarks ​=== +== Remarks == 
-If you set this style, then it will be used for drawing.+If you set this style, then it will be used for drawing. ​If you use the default styles, you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle. 
 +== Return Value == 
 +  * Type:​[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
  
-If you use the default styles, you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle. +** {{wiki:​PublicProperty.gif|}} DefaultTextStyle **
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]<​!-- ThinkGeo.MapSuite.Core.PointStyle --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> 
-[[#Public Properties|Go Back]] 
-==== DefaultTextStyle ==== 
 This property gets and sets the default TextStyle used to draw. This property gets and sets the default TextStyle used to draw.
-=== Remarks ​=== +== Remarks == 
-If you set this style, then it will be used for drawing.+If you set this style, then it will be used for drawing. ​If you use the default styles, you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle. 
 +== Return Value == 
 +  * Type:​[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
  
-If you use the default styles, you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle. +** {{wiki:​PublicProperty.gif|}} ApplyUntilZoomLevel **
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]<​!-- ThinkGeo.MapSuite.Core.TextStyle --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> +This property gets and sets the zoom to which we will use this zoom level'​s styles. 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== IsActive ==== +This property allows you to apply the current ZoomLevel'​s styles across many ZoomLevels. For example, you may want to display roads as a thin line from ZoomLevel10 through ZoomLevel15. To accomplish ​this easily, you can set the correct styles on ZoomLevel10 ​and then set its ApplyUntilZoomLevel property to Level15. This will mean that Level10'​s style will be used until Level15. There is no need to set Level11, Level12, Level13 and so on. 
-This property gets and sets whether ​the ZoomLevel is active and should draw. +== Return Value == 
-=== Remarks ​=== +  ​* ​Type:​[[ThinkGeo.MapSuite.Core.ApplyUntilZoomLevel|ApplyUntilZoomLevel]] 
-Setting ​the value to false means that this zoom level will not be considered in the ZoomLevelSet ​and thus will not draw. + 
-=== Return Value === +** {{wiki:​PublicProperty.gif|}} Name **
-^ Return ​Type ^ +
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> 
-[[#Public Properties|Go Back]] 
-==== Name ==== 
 This property gets and sets the name for the ZoomLevel. This property gets and sets the name for the ZoomLevel.
-=== Remarks ​===+== Remarks ==
 The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc. The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:String
-| String<​!-- System.String ​--> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> +** {{wiki:​PublicProperty.gif|}} CustomStyles **
-[[#Public Properties|Go Back]] +
-==== Scale ==== +
-This property gets and sets the scale for the ZoomLevel. +
-=== Remarks === +
-The scale +
-=== Return Value === +
-^ Return Type ^ +
-| Double<​!-- System.Double --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.ZoomLevel --> +This property gets a collection of custom styles used to draw. 
-[[#Public Properties|Go Back]] +== Remarks == 
-===== Protected Properties ===== +This is a collection of styles to draw. If you only need to draw one style, then we suggest you do not use this collection and instead use one of the default styles, such as DefaultAreaStyle,​ DefaultLineStyle,​ DefaultTextStyle,​ etc. 
-===== Public Events ===== +== Return Value == 
-__NOTOC__ +  * Type:​Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]> 
-[[Category:MapSuiteCore]] + 
-[[Category:​ThinkGeo.MapSuite.Core]] +==== Protected Properties ==== 
-[[Category:​UpdateDocumentation]]+** {{wiki:​ProtectedProperty.gif|}} IsDefault ** 
 + 
 +N/A 
 +== Remarks ​== 
 +N/A 
 +== Return Value == 
 +  * Type:Boolean 
 + 
 +==== Public Events ====
  
thinkgeo.mapsuite.core.zoomlevel.1440040130.txt.gz · Last modified: 2015/09/17 10:43 (external edit)

Page Tools