Style¶

Inheritance Hierarchy¶

• Object
• Style
  • HeatStyle
  • NoaaWeatherStationStyle
  • PointBaseStyle
  • AreaStyle
  • LineStyle
  • PositionStyle
  • ClassBreakStyle
  • ClusterPointStyle
  • CompositeStyle
  • DotDensityStyle
  • FilterStyle
  • FleeBooleanStyle
  • GradientStyle
  • RegexStyle
  • StyleJsonStyle
  • ValueStyle

Members Summary¶

Public Constructors Summary¶

Protected Constructors Summary¶

Public Properties Summary¶

Protected Properties Summary¶

Public Methods Summary¶

Protected Methods Summary¶

Public Events Summary¶

Members Detail¶

Public Constructors¶

Protected Constructors¶

Style()¶

Summary

This is the default constructor for the style and should be called by inherited classes.

Remarks

This is the default constructor for the style and should be called by inherited classes.

Return Value

Parameters

Public Properties¶

Filters¶

Summary

N/A

Remarks

N/A

Return Value

Collection<String>

IsActive¶

Summary

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

Boolean

Name¶

Summary

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

String

RequiredColumnNames¶

Summary

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

Collection<String>

Protected Properties¶

FiltersCore¶

Summary

N/A

Remarks

N/A

Return Value

Collection<String>

IsDefault¶

Summary

N/A

Remarks

N/A

Return Value

Boolean

Public Methods¶

CloneDeep()¶

Summary

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

Parameters

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

Summary

This method draws the features on the view 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 view 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

Parameters

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

Summary

This method draws the shapes on the view 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 view 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

Parameters

DrawSample(GeoCanvas,DrawingRectangleF)¶

Summary

This method draws a sample feature on the view you provided.

Remarks

This method is the concrete wrapper for the abstract method DrawSampleCore. In this method we draw a sample style on the view 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

Parameters

DrawSample(GeoCanvas)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Equals(Object)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetHashCode()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetRequiredColumnNames()¶

Summary

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

Parameters

GetType()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

LoadStyle(Uri)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

LoadStyle(Stream)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

SaveStyle(String)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

SaveStyle(Stream)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

ToString()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Protected Methods¶

CloneDeepCore()¶

Summary

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

Parameters

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

Summary

This method draws the features on the view you provided.

Remarks

This abstract method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the view you provided. Each style (based on its properties) may draw each feature differently. When implementing this abstract 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

Parameters

DrawSampleCore(GeoCanvas,DrawingRectangleF)¶

Summary

This method draws a sample feature on the view you provided.

Remarks

This virtual method is called from the concrete public method Draw. In this method, we draw a sample style on the view you provided. This is typically used to display a legend or other sample area. When implementing this virtual method, consider the view size and draw the sample image appropriately. You should keep in mind that the sample typically shows up on a legend.

Return Value

Parameters

Finalize()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

GetRequiredColumnNamesCore()¶

Summary

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

Parameters

MemberwiseClone()¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

ParseSegments(String,Char,Char,Action<String>)¶

Summary

N/A

Remarks

N/A

Return Value

Parameters

Public Events¶