AreaStyle¶
Inheritance Hierarchy¶
ObjectStyle
Members Summary¶
Public Constructors Summary¶
| Name |
|---|
AreaStyle() |
AreaStyle(GeoBrush) |
AreaStyle(GeoPen) |
AreaStyle(GeoPen,GeoBrush) |
AreaStyle(GeoPen,GeoBrush,PenBrushDrawingOrder) |
Protected Constructors Summary¶
| Name |
|---|
| N/A |
Public Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
CustomAreaStyles | Collection<AreaStyle> | This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other. |
DrawingLevel | DrawingLevel | N/A |
FillBrush | GeoBrush | This property gets and sets the solid brush you want to use to fill in the area features. |
Filters | Collection<String> | N/A |
IsActive | Boolean | N/A |
Name | String | N/A |
OutlinePen | GeoPen | This property gets and sets the outline pen you want to use to outline the features. |
PenBrushDrawingOrder | PenBrushDrawingOrder | This property gets and sets the pen and brush drawing order. |
RequiredColumnNames | Collection<String> | N/A |
XOffsetInPixel | Single | This property gets and sets the X pixel offset for drawing each feature. |
YOffsetInPixel | Single | This property gets and sets the Y pixel offset for drawing each feature. |
Protected Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
FiltersCore | Collection<String> | N/A |
IsDefault | Boolean | N/A |
Shadow | AreaStyle | N/A |
Public Methods Summary¶
Protected Methods Summary¶
Public Events Summary¶
| Name | Event Arguments | Description |
|---|---|---|
| N/A | N/A | N/A |
Members Detail¶
Public Constructors¶
| Name |
|---|
AreaStyle() |
AreaStyle(GeoBrush) |
AreaStyle(GeoPen) |
AreaStyle(GeoPen,GeoBrush) |
AreaStyle(GeoPen,GeoBrush,PenBrushDrawingOrder) |
Protected Constructors¶
Public Properties¶
CustomAreaStyles¶
Summary
This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other.
Remarks
Using this collection, you can stack multiple area styles on top of each other. When we draw the features, we will draw them in order that they exist in the collection. You can use these stacks to create drop shadow effects, multiple colored outlines, etc.
Return Value
Collection<AreaStyle>
DrawingLevel¶
Summary
N/A
Remarks
N/A
Return Value
FillBrush¶
Summary
This property gets and sets the solid brush you want to use to fill in the area features.
Remarks
This solid brush is used to fill in the area features that will draw. You can also optionally specify an outline pen to give the area an outline. The default solid brush has a fill color of transparent, which means it will not draw anything.
Return Value
Filters¶
Summary
N/A
Remarks
N/A
Return Value
Collection<String>
IsActive¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
Name¶
Summary
N/A
Remarks
N/A
Return Value
String
OutlinePen¶
Summary
This property gets and sets the outline pen you want to use to outline the features.
Remarks
This outline pen is used to outline the features that will draw. You can also optionally specify a fill brush to give the area a solid fill. The default outline pen color is transparent, which means it will not draw anything.
Return Value
PenBrushDrawingOrder¶
Summary
This property gets and sets the pen and brush drawing order.
Remarks
This property controls whether the outline pen or the fill brush is drawn first. The default is for the fill brush to be drawn first. If you have the outline pen draw first then the thickness of the pen will be smaller, creating a subtle but noticeable effect.
Return Value
RequiredColumnNames¶
Summary
N/A
Remarks
N/A
Return Value
Collection<String>
XOffsetInPixel¶
Summary
This property gets and sets the X pixel offset for drawing each feature.
Remarks
This property allows you to specify an X offset. When combined with a Y offset, it enables you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to align it with raster satellite data.
Return Value
Single
YOffsetInPixel¶
Summary
This property gets and sets the Y pixel offset for drawing each feature.
Remarks
This property allows you to specify a Y offset. When combined with an X offset, it enables you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to align it with raster satellite data.
Return Value
Single
Protected Properties¶
FiltersCore¶
Summary
N/A
Remarks
N/A
Return Value
Collection<String>
IsDefault¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
Shadow¶
Summary
N/A
Remarks
N/A
Return Value
Public Methods¶
CloneDeep()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Style | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
CreateHatchStyle(GeoHatchStyle,GeoColor,GeoColor)¶
Summary
This method returns an AreaStyle with a hatch pattern.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This property is the color of the foreground of the hatch pattern. |
Parameters
| Name | Type | Description |
|---|---|---|
| hatchStyle | GeoHatchStyle | This parameter is the hatch pattern to be used. |
| foregroundBrushColor | GeoColor | This property is the color of the foreground of the hatch pattern. |
| backgroundBrushColor | GeoColor | This property is the color of the background of the hatch pattern. |
CreateHatchStyle(GeoHatchStyle,GeoColor,GeoColor,GeoColor)¶
Summary
This method returns an AreaStyle with a hatch pattern.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method returns an AreaStyle with a hatch pattern. |
Parameters
| Name | Type | Description |
|---|---|---|
| hatchStyle | GeoHatchStyle | This parameter is the hatch pattern to be used. |
| foregroundBrushColor | GeoColor | This property is the color of the foreground of the hatch pattern. |
| backgroundBrushColor | GeoColor | This property is the color of the background of the hatch pattern. |
| outlinePenColor | GeoColor | This parameter is the border color for the area. |
CreateHatchStyle(GeoHatchStyle,GeoColor,GeoColor,GeoColor,Int32,LineDashStyle,Single,Single)¶
Summary
This method returns a GeoHatchStyle.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
AreaStyle | This method returns an AreaStyle with a hatch pattern. |
Parameters
| Name | Type | Description |
|---|---|---|
| hatchStyle | GeoHatchStyle | This parameter is the hatch pattern to be used. |
| foregroundBrushColor | GeoColor | This property is the color of the foreground of the hatch pattern. |
| backgroundColor | GeoColor | This property is the color of the background of the hatch pattern. |
| outlinePenColor | GeoColor | This parameter is the border color for the area. |
| outlinePenWidth | Int32 | This parameter is the border width for the area. |
| outlineDashStyle | LineDashStyle | This parameter is the dahs style to be used for the border. |
| xOffsetInPixel | Single | This parameter is the pixel offset for X. |
| yOffsetInPixel | Single | This parameter is the pixel offset for Y. |
CreateHueFamilyAreaStyle(GeoColor,GeoColor,Int32)¶
Summary
This method returns an AreaStyle.
Remarks
None.
Return Value
| Type | Description |
|---|---|
AreaStyle | This method returns an AreaStyle. |
Parameters
| Name | Type | Description |
|---|---|---|
| outlinePenColor | GeoColor | This parameter specifies the GeoPen you want to use on the outline of the area style. |
| baseColor | GeoColor | The base GeoColor of the hue family colors. |
| numberOfColors | Int32 | The number of GeoColors in hue family to construct the areastyle. |
CreateHueFamilyLinearGradientAreaStyle(GeoColor,GeoColor,Int32,GeoColor,GeoColor,Single)¶
Summary
This method returns an AreaStyle in a family of hue-related colors drawn with a linear gradient.
Remarks
None.
Return Value
| Type | Description |
|---|---|
AreaStyle | This method returns an AreaStyle in a family of hue-related colors drawn with a linear gradient. |
Parameters
| Name | Type | Description |
|---|---|---|
| outlinePenColor | GeoColor | This parameter specifies the GeoPen you want to use on the outline of the AreaStyle. |
| baseColor | GeoColor | The base GeoColor for the hue family of colors. |
| numberOfColors | Int32 | The number of GeoColors in the hue family to construct the AreaStyle. |
| fromColor | GeoColor | This parameter represents the starting GeoColor for the gradient. |
| toColor | GeoColor | This parameter represents the ending GeoColor for the gradient. |
| angle | Single | This parameter represents the angle for the gradient. |
CreateLinearGradientStyle(GeoColor,GeoColor,Single)¶
Summary
This method returns a linear gradient style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method returns an AreaStyle. |
Parameters
| Name | Type | Description |
|---|---|---|
| fromColor | GeoColor | This parameter represents the starting GeoColor for the gradient. |
| toColor | GeoColor | This parameter represents the ending GeoColor for the gradient. |
| angle | Single | This parameter represents the angle of the color changing from start to end. |
CreateLinearGradientStyle(GeoColor,GeoColor,Single,GeoColor)¶
Summary
This method returns a linear gradient style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method returns an AreaStyle. |
Parameters
| Name | Type | Description |
|---|---|---|
| fromColor | GeoColor | This parameter represents the starting GeoColor for the gradient. |
| toColor | GeoColor | This parameter represents the ending GeoColor for the gradient. |
| angle | Single | This parameter represents the angle of the color changing from start to end. |
| outlinePenColor | GeoColor | This parameter represents the outline pen color of the area style. |
CreateQualityFamilyAreaStyle(GeoColor,GeoColor,Int32)¶
Summary
This method returns an AreaStyle in a family of quality-realted colors.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
AreaStyle | This method returns an AreaStyle in a family of quality-realted colors. |
Parameters
| Name | Type | Description |
|---|---|---|
| outlinePenColor | GeoColor | This parameter specifies the GeoPen you want to use on the outline of the AreaStyle. |
| baseColor | GeoColor | The base GeoColor for the quality family of colors. |
| numberOfColors | Int32 | The number of GeoColors in the quality-based family to construct the AreaStyle. |
CreateQualityFamilyLinearGradientAreaStyle(GeoColor,GeoColor,Int32,GeoColor,GeoColor,Single)¶
Summary
This method returns an AreaStyle in a family of quality-related colors drawn with a linear gradient.
Remarks
None.
Return Value
| Type | Description |
|---|---|
AreaStyle | This method returns an AreaStyle in a family of quality-related colors drawn with a linear gradient. |
Parameters
| Name | Type | Description |
|---|---|---|
| outlinePenColor | GeoColor | This parameter specifies the GeoPen you want to use on the outline of the AreaStyle. |
| baseColor | GeoColor | The base GeoColor for the quality family of colors. |
| numberOfColors | Int32 | The number of GeoColors in quality-based family to construct the AreaStyle. |
| fromColor | GeoColor | This parameter represents the starting GeoColor for the gradient. |
| toColor | GeoColor | This parameter represents the ending GeoColor for the gradient. |
| angle | Single | This parameter represents the angle for the gradient. |
CreateSimpleAreaStyle(GeoColor)¶
Summary
This method builds a simple area style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method builds a simple area style. |
Parameters
| Name | Type | Description |
|---|---|---|
| fillBrushColor | GeoColor | This parameter is the fill color of the area. |
CreateSimpleAreaStyle(GeoColor,GeoColor)¶
Summary
This method builds a simple area style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method builds a simple area style. |
Parameters
| Name | Type | Description |
|---|---|---|
| fillBrushColor | GeoColor | This parameter is the fill color for the area. |
| outlinePenColor | GeoColor | This parameter is the outline pen color for the area. |
CreateSimpleAreaStyle(GeoColor,GeoColor,Int32)¶
Summary
This method builds a simple area style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method builds a simple area style. |
Parameters
| Name | Type | Description |
|---|---|---|
| fillBrushColor | GeoColor | This parameter is the fill color for the area. |
| outlinePenColor | GeoColor | This parameter is the outline pen color for the area. |
| outlinePenWidth | Int32 | This parameter is the outline pen width for the area. |
CreateSimpleAreaStyle(GeoColor,GeoColor,Int32,LineDashStyle)¶
Summary
This method builds a simple area style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method builds a simple area style. |
Parameters
| Name | Type | Description |
|---|---|---|
| fillBrushColor | GeoColor | This parameter is the fill color for the area. |
| outlinePenColor | GeoColor | This parameter is the outline pen color for the area. |
| outlinePenWidth | Int32 | This parameter is the outline pen width for the area. |
| borderStyle | LineDashStyle | This parameter is the BorderStyle for the area style. |
CreateSimpleAreaStyle(GeoColor,Single,Single)¶
Summary
This method builds a simple area style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method builds a simple area style. |
Parameters
| Name | Type | Description |
|---|---|---|
| fillBrushColor | GeoColor | This parameter is the fill color for the area. |
| xOffsetInPixel | Single | This parameter is the X pixels offset for this area. |
| yOffsetInPixel | Single | This parameter is the Y pixels offset for this area. |
CreateSimpleAreaStyle(GeoColor,GeoColor,Single,Single)¶
Summary
This method builds a simple area style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method builds a simple area style. |
Parameters
| Name | Type | Description |
|---|---|---|
| fillBrushColor | GeoColor | This parameter is the fill color for the area. |
| outlinePenColor | GeoColor | This parameter is the outline color for the area. |
| xOffsetInPixel | Single | This parameter is the X pixels offset for this area. |
| yOffsetInPixel | Single | This parameter is the Y pixels offset for this area. |
CreateSimpleAreaStyle(GeoColor,GeoColor,Int32,Single,Single)¶
Summary
This method builds a simple area style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method builds a simple area style. |
Parameters
| Name | Type | Description |
|---|---|---|
| fillBrushColor | GeoColor | This parameter is the fill color for the area. |
| outlinePenColor | GeoColor | This parameter is the outline pen color for the area. |
| outlinePenWidth | Int32 | This parameter is the outline pen width for the area. |
| xOffsetInPixel | Single | This parameter is the X pixels offset for this area. |
| yOffsetInPixel | Single | This parameter is the Y pixels offset for this area. |
CreateSimpleAreaStyle(GeoColor,GeoColor,Int32,LineDashStyle,Single,Single)¶
Summary
This method builds a simple area style.
Remarks
None
Return Value
| Type | Description |
|---|---|
AreaStyle | This method builds a simple area style. |
Parameters
| Name | Type | Description |
|---|---|---|
| fillBrushColor | GeoColor | This parameter is the fill color for the area. |
| outlinePenColor | GeoColor | This parameter is the outline pen color for the area. |
| outlinePenWidth | Int32 | This parameter is the outline pen width for the area. |
| borderStyle | LineDashStyle | This parameter is the BorderStyle for the area. |
| xOffsetInPixel | Single | This parameter is the X pixels offset for this area. |
| yOffsetInPixel | Single | This parameter is the Y pixels offset for this area. |
Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| features | IEnumerable<Feature> | N/A |
| canvas | GeoCanvas | N/A |
| labelsInThisLayer | Collection<SimpleCandidate> | N/A |
| labelsInAllLayers | Collection<SimpleCandidate> | N/A |
Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| shapes | IEnumerable<BaseShape> | N/A |
| canvas | GeoCanvas | N/A |
| labelsInThisLayer | Collection<SimpleCandidate> | N/A |
| labelsInAllLayers | Collection<SimpleCandidate> | N/A |
DrawSample(GeoCanvas,DrawingRectangleF)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | N/A |
| drawingExtent | DrawingRectangleF | N/A |
DrawSample(GeoCanvas)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | N/A |
Equals(Object)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | N/A |
GetHashCode()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Int32 | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetRequiredColumnNames()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Collection<String> | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetType()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Type | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Parse(String)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
AreaStyle | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| styleJson | String | N/A |
SaveStyle(String)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| filePathName | String | N/A |
SaveStyle(Stream)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| stream | Stream | N/A |
ToString()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Protected Methods¶
CloneDeepCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Style | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)¶
Summary
This method draws the features on the view 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 view 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 | Description |
|---|---|
Void | None |
Parameters
| Name | Type | Description |
|---|---|---|
| features | IEnumerable<Feature> | This parameter represents the features you want to draw on the view. |
| canvas | GeoCanvas | This parameter represents the view you want to draw the features on. |
| labelsInThisLayer | Collection<SimpleCandidate> | The labels will be drawn in the current layer only. |
| labelsInAllLayers | Collection<SimpleCandidate> | The labels will be drawn in all layers. |
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
| Type | Description |
|---|---|
Void | None |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | This parameter represents the view you want to draw the features on. |
| drawingExtent | DrawingRectangleF | N/A |
Finalize()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetRequiredColumnNamesCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Collection<String> | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
MemberwiseClone()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Object | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Parse(JObject)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
AreaStyle | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| jObject | JObject | N/A |