User Tools

Site Tools


12.0:apis:thinkgeo.core.zoomlevel

ThinkGeo.Core.ZoomLevel

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.Core.ZoomLevel

Members Summary

Public Constructors

ZoomLevel()

  • This is a constructor for the class.
Remarks
  • This is the default constructor. If you use this constructor, you should set the require properties on the class manually.
Parameters

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.

Protected Constructors

Public Methods

GetRequiredColumnNames()

  • N/A
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.
Return Value
  • Type:Collection<String>
  • Description:This method returns a collection containing the required column names.
Parameters

Draw(GeoCanvas,IEnumerable<Feature>,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

  • N/A
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.
Return Value
  • Type:Void
  • Description:None
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the Canvas used to draw the InternalFeatures.
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter is the collection of features that we will draw.
  • currentLayerLabels
    • Type:Collection<SimpleCandidate>
    • Description:This parameter is the collection of labels in the current layer.
  • allLayerLabels
    • Type:Collection<SimpleCandidate>
    • Description:This parameter is the collection of labels in all layers.

Draw(GeoCanvas,IEnumerable<BaseShape>,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

  • N/A
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.
Return Value
  • Type:Void
  • Description:None
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the Canvas used to draw the InternalFeatures.
  • shapes
    • Type:IEnumerable<BaseShape>
    • Description:This parameter is the collection of shapes that we will draw.
  • currentLayerLabels
    • Type:Collection<SimpleCandidate>
    • Description:This parameter is the collection of labels in the current layer.
  • allLayerLabels
    • Type:Collection<SimpleCandidate>
    • Description:This parameter is the collection of labels in all layers.

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

Protected Methods

DrawCore(GeoCanvas,IEnumerable<Feature>,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

  • N/A
Remarks
  • This method draws the representation of the Layer based on the extent you provided.
Return Value
  • Type:Void
  • Description:None
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the Canvas used to draw the InternalFeatures.
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter is the collection of feature that we will draw.
  • currentLayerLabels
    • Type:Collection<SimpleCandidate>
    • Description:This parameter is the collection of labels in the current layer.
  • allLayerLabels
    • Type:Collection<SimpleCandidate>
    • Description:This parameter is the collection of labels in all layers.

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Public Properties

IsActive

  • N/A
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

Scale

  • N/A
Remarks
  • The scale
Return Value
  • Type:Double

DefaultAreaStyle

  • N/A
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.
Return Value

DefaultLineStyle

  • N/A
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.
Return Value

DefaultPointStyle

  • N/A
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.
Return Value

DefaultTextStyle

  • N/A
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.
Return Value

ApplyUntilZoomLevel

  • N/A
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

Name

  • N/A
Remarks
  • 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
  • Type:String

CustomStyles

  • N/A
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.
Return Value

Protected Properties

IsDefault

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Public Events

12.0/apis/thinkgeo.core.zoomlevel.txt · Last modified: 2019/09/26 09:35 (external edit)