thinkgeo.mapsuite.portablecore.zoomlevel
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.zoomlevel [2015/09/21 08:22] admin |
thinkgeo.mapsuite.portablecore.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}} | ||
| + | |||
| This class defines how InternalFeatures will be drawn based on their scale. | This class defines how InternalFeatures will be drawn based on their scale. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 8: | Line 11: | ||
| ** {{wiki:PublicMethod.gif|}} ZoomLevel() ** | ** {{wiki:PublicMethod.gif|}} ZoomLevel() ** | ||
| - | This is a constructor for the class. | + | * //This is a constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | This is the default constructor. If you use this constructor, you should set the require properties on the class manually. | + | * //This is the default constructor. If you use this constructor, you should set the require properties on the class manually.// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} ZoomLevel(Double) ** | ** {{wiki:PublicMethod.gif|}} ZoomLevel(Double) ** | ||
| - | This is a constructor for the class. | + | * //This is a constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | This constructor allows you to provide the scale for this ZoomLevel. | + | * //This constructor allows you to provide the scale for this ZoomLevel.// |
| == Parameters == | == Parameters == | ||
| * //scale// | * //scale// | ||
| Line 28: | Line 31: | ||
| ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ||
| - | This method returns the column data for each feature that is required for the styles to properly draw. | + | * //This method returns the column data for each feature that is required for the styles to properly draw.// |
| == Remarks == | == 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. | + | * //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.// |
| == Return Value == | == Return Value == | ||
| Line 40: | Line 43: | ||
| ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,IEnumerable<Feature>,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,IEnumerable<Feature>,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method draws the ZoomLevel. | + | * //This method draws the ZoomLevel.// |
| == Remarks == | == 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 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.// |
| == Return Value == | == Return Value == | ||
| Line 68: | Line 71: | ||
| ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,IEnumerable<BaseShape>,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,IEnumerable<BaseShape>,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method draws the ZoomLevel. | + | * //This method draws the ZoomLevel.// |
| == Remarks == | == 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 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.// |
| == Return Value == | == Return Value == | ||
| Line 96: | Line 99: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 108: | Line 111: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 124: | Line 127: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 136: | Line 139: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 149: | Line 152: | ||
| ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,IEnumerable<Feature>,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,IEnumerable<Feature>,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
| - | This method draws the ZoomLevel. | + | * //This method draws the ZoomLevel.// |
| == Remarks == | == Remarks == | ||
| - | This method draws the representation of the Layer based on the extent you provided. | + | * //This method draws the representation of the Layer based on the extent you provided.// |
| == Return Value == | == Return Value == | ||
| Line 175: | Line 178: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} f0M=() ** | + | ** {{wiki:ProtectedMethod.gif|}} GetStylesForDrawing() ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 189: | Line 192: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 201: | Line 204: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 214: | Line 217: | ||
| ** {{wiki:PublicProperty.gif|}} IsActive ** | ** {{wiki:PublicProperty.gif|}} IsActive ** | ||
| - | This property gets and sets whether the ZoomLevel is active and should draw. | + | * //This property gets and sets whether the ZoomLevel is active and should draw.// |
| == Remarks == | == Remarks == | ||
| - | Setting the value to false means that this zoom level will not be considered in the ZoomLevelSet and thus will not draw. | + | * //Setting the value to false means that this zoom level will not be considered in the ZoomLevelSet and thus will not draw.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 222: | Line 225: | ||
| ** {{wiki:PublicProperty.gif|}} Scale ** | ** {{wiki:PublicProperty.gif|}} Scale ** | ||
| - | This property gets and sets the scale for the ZoomLevel. | + | * //This property gets and sets the scale for the ZoomLevel.// |
| == Remarks == | == Remarks == | ||
| - | The scale | + | * //The scale// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 230: | Line 233: | ||
| ** {{wiki:PublicProperty.gif|}} DefaultAreaStyle ** | ** {{wiki:PublicProperty.gif|}} 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 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. | + | * //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 == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | ||
| Line 238: | Line 241: | ||
| ** {{wiki:PublicProperty.gif|}} DefaultLineStyle ** | ** {{wiki:PublicProperty.gif|}} 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 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. | + | * //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 == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] | * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] | ||
| Line 246: | Line 249: | ||
| ** {{wiki:PublicProperty.gif|}} DefaultPointStyle ** | ** {{wiki:PublicProperty.gif|}} 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 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. | + | * //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 == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]] | * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]] | ||
| Line 254: | Line 257: | ||
| ** {{wiki:PublicProperty.gif|}} DefaultTextStyle ** | ** {{wiki:PublicProperty.gif|}} 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 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. | + | * //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 == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | ||
| Line 262: | Line 265: | ||
| ** {{wiki:PublicProperty.gif|}} ApplyUntilZoomLevel ** | ** {{wiki:PublicProperty.gif|}} ApplyUntilZoomLevel ** | ||
| - | This property gets and sets the zoom to which we will use this zoom level's styles. | + | * //This property gets and sets the zoom to which we will use this zoom level's styles.// |
| == Remarks == | == 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. | + | * //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 Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.ApplyUntilZoomLevel|ApplyUntilZoomLevel]] | * Type:[[ThinkGeo.MapSuite.Core.ApplyUntilZoomLevel|ApplyUntilZoomLevel]] | ||
| Line 270: | Line 273: | ||
| ** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| * Type:String | * Type:String | ||
| Line 278: | Line 281: | ||
| ** {{wiki:PublicProperty.gif|}} CustomStyles ** | ** {{wiki:PublicProperty.gif|}} CustomStyles ** | ||
| - | This property gets a collection of custom styles used to draw. | + | * //This property gets a collection of custom styles used to draw.// |
| == Remarks == | == Remarks == | ||
| - | 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. | + | * //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.// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]> | * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]> | ||
| ==== Protected Properties ==== | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} uBs= ** | + | ** {{wiki:ProtectedProperty.gif|}} IsDefault ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
thinkgeo.mapsuite.portablecore.zoomlevel.1442823720.txt.gz ยท Last modified: 2015/09/21 08:22 (external edit)