User Tools

Site Tools


12.0:apis:thinkgeo.core.areastyle

ThinkGeo.Core.AreaStyle

Inheritance Hierarchy

Members Summary

Public Constructors

AreaStyle()

  • This is the constructor for the class.
Remarks
  • If you use this constructor, you will need to set the properties of the fill brush and outline pen manually.
Parameters

AreaStyle(GeoBrush)

  • This is the constructor for the class.
Remarks
  • This constructor allows you to specify just a fill brush. In this way, the area you draw will not have an outline.
Parameters
  • fillBrush
    • Type:GeoBrush
    • Description:This parameter is the solid brush you want to fill the area with.

AreaStyle(GeoPen)

  • This is the constructor for the class.
Remarks
  • This constructor allows you to specify just an outline pen. In this way, the area you draw will have an outline, but a transparent interior (no fill).
Parameters
  • outlinePen
    • Type:GeoPen
    • Description:This parameter is the outline pen you want to use to outline the area.

AreaStyle(GeoPen,GeoBrush)

  • This is the constructor for the class.
Remarks
  • This constructor allows you to specify a fill brush and an outline pen.
Parameters
  • outlinePen
    • Type:GeoPen
    • Description:This parameter is the outline pen you want to use to outline the area.
  • fillBrush
    • Type:GeoBrush
    • Description:This parameter is the solid brush you wish to fill the area with.

AreaStyle(GeoPen,GeoBrush,PenBrushDrawingOrder)

  • This is the constructor for the class.
Remarks
  • This constructor allows you to specify a fill brush and an outline pen. It also allows you to specify which is drawn first. If the pen is drawn first, the outline will be thinner than if the pen is drawn last. The effect is subtle but noticeable.
Parameters
  • outlinePen
    • Type:GeoPen
    • Description:This parameter is the outline pen you want to use to outline the area.
  • fillBrush
    • Type:GeoBrush
    • Description:This parameter is the solid brush you wish to fill the area with.
  • penBrushDrawingOrder
    • Description:This parameter allows you to choose whether the outline pen or the fill brush is drawn first.

Protected Constructors

Public Methods

CloneDeep()

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

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • shapes
    • Type:IEnumerable<BaseShape>
    • Description:N/A

GetRequiredColumnNames()

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

DrawSample(GeoCanvas,DrawingRectangleF)

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

DrawSample(GeoCanvas)

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

SaveStyle(String)

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

SaveStyle(Stream)

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

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

Parse(String)

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

CreateSimpleAreaStyle(GeoColor)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method builds a simple area style.
Parameters
  • fillBrushColor
    • Type:GeoColor
    • Description:This parameter is the fill color of the area.

CreateSimpleAreaStyle(GeoColor,GeoColor)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method builds a simple area style.
Parameters
  • fillBrushColor
    • Type:GeoColor
    • Description:This parameter is the fill color for the area.
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter is the outline pen color for the area.

CreateSimpleAreaStyle(GeoColor,GeoColor,Int32)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method builds a simple area style.
Parameters
  • fillBrushColor
    • Type:GeoColor
    • Description:This parameter is the fill color for the area.
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter is the outline pen color for the area.
  • outlinePenWidth
    • Type:Int32
    • Description:This parameter is the outline pen width for the area.

CreateSimpleAreaStyle(GeoColor,GeoColor,Int32,LineDashStyle)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method builds a simple area style.
Parameters
  • fillBrushColor
    • Type:GeoColor
    • Description:This parameter is the fill color for the area.
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter is the outline pen color for the area.
  • outlinePenWidth
    • Type:Int32
    • Description:This parameter is the outline pen width for the area.
  • borderStyle
    • Description:This parameter is the BorderStyle for the area style.

CreateSimpleAreaStyle(GeoColor,Single,Single)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method builds a simple area style.
Parameters
  • fillBrushColor
    • Type:GeoColor
    • Description:This parameter is the fill color for the area.
  • xOffsetInPixel
    • Type:Single
    • Description:This parameter is the X pixels offset for this area.
  • yOffsetInPixel
    • Type:Single
    • Description:This parameter is the Y pixels offset for this area.

CreateSimpleAreaStyle(GeoColor,GeoColor,Single,Single)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method builds a simple area style.
Parameters
  • fillBrushColor
    • Type:GeoColor
    • Description:This parameter is the fill color for the area.
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter is the outline color for the area.
  • xOffsetInPixel
    • Type:Single
    • Description:This parameter is the X pixels offset for this area.
  • yOffsetInPixel
    • Type:Single
    • Description:This parameter is the Y pixels offset for this area.

CreateSimpleAreaStyle(GeoColor,GeoColor,Int32,Single,Single)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method builds a simple area style.
Parameters
  • fillBrushColor
    • Type:GeoColor
    • Description:This parameter is the fill color for the area.
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter is the outline pen color for the area.
  • outlinePenWidth
    • Type:Int32
    • Description:This parameter is the outline pen width for the area.
  • xOffsetInPixel
    • Type:Single
    • Description:This parameter is the X pixels offset for this area.
  • yOffsetInPixel
    • Type:Single
    • Description:This parameter is the Y pixels offset for this area.

CreateSimpleAreaStyle(GeoColor,GeoColor,Int32,LineDashStyle,Single,Single)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method builds a simple area style.
Parameters
  • fillBrushColor
    • Type:GeoColor
    • Description:This parameter is the fill color for the area.
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter is the outline pen color for the area.
  • outlinePenWidth
    • Type:Int32
    • Description:This parameter is the outline pen width for the area.
  • borderStyle
    • Description:This parameter is the BorderStyle for the area.
  • xOffsetInPixel
    • Type:Single
    • Description:This parameter is the X pixels offset for this area.
  • yOffsetInPixel
    • Type:Single
    • Description:This parameter is the Y pixels offset for this area.

CreateHatchStyle(GeoHatchStyle,GeoColor,GeoColor)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This property is the color of the foreground of the hatch pattern.
Parameters
  • hatchStyle
    • Description:This parameter is the hatch pattern to be used.
  • foregroundBrushColor
    • Type:GeoColor
    • Description:This property is the color of the foreground of the hatch pattern.
  • backgroundBrushColor
    • Type:GeoColor
    • Description:This property is the color of the background of the hatch pattern.

CreateHatchStyle(GeoHatchStyle,GeoColor,GeoColor,GeoColor)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method returns an AreaStyle with a hatch pattern.
Parameters
  • hatchStyle
    • Description:This parameter is the hatch pattern to be used.
  • foregroundBrushColor
    • Type:GeoColor
    • Description:This property is the color of the foreground of the hatch pattern.
  • backgroundBrushColor
    • Type:GeoColor
    • Description:This property is the color of the background of the hatch pattern.
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter is the border color for the area.

CreateHatchStyle(GeoHatchStyle,GeoColor,GeoColor,GeoColor,Int32,LineDashStyle,Single,Single)

  • N/A
Remarks
  • N/A
Return Value
  • Type:AreaStyle
  • Description:This method returns an AreaStyle with a hatch pattern.
Parameters
  • hatchStyle
    • Description:This parameter is the hatch pattern to be used.
  • foregroundBrushColor
    • Type:GeoColor
    • Description:This property is the color of the foreground of the hatch pattern.
  • backgroundColor
    • Type:GeoColor
    • Description:This property is the color of the background of the hatch pattern.
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter is the border color for the area.
  • outlinePenWidth
    • Type:Int32
    • Description:This parameter is the border width for the area.
  • outlineDashStyle
    • Description:This parameter is the dahs style to be used for the border.
  • xOffsetInPixel
    • Type:Single
    • Description:This parameter is the pixel offset for X.
  • yOffsetInPixel
    • Type:Single
    • Description:This parameter is the pixel offset for Y.

CreateLinearGradientStyle(GeoColor,GeoColor,Single)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method returns an AreaStyle.
Parameters
  • fromColor
    • Type:GeoColor
    • Description:This parameter represents the starting GeoColor for the gradient.
  • toColor
    • Type:GeoColor
    • Description:This parameter represents the ending GeoColor for the gradient.
  • angle
    • Type:Single
    • Description:This parameter represents the angle of the color changing from start to end.

CreateLinearGradientStyle(GeoColor,GeoColor,Single,GeoColor)

  • N/A
Remarks
  • None
Return Value
  • Type:AreaStyle
  • Description:This method returns an AreaStyle.
Parameters
  • fromColor
    • Type:GeoColor
    • Description:This parameter represents the starting GeoColor for the gradient.
  • toColor
    • Type:GeoColor
    • Description:This parameter represents the ending GeoColor for the gradient.
  • angle
    • Type:Single
    • Description:This parameter represents the angle of the color changing from start to end.
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter represents the outline pen color of the area style.

CreateHueFamilyAreaStyle(GeoColor,GeoColor,Int32)

  • N/A
Remarks
  • None.
Return Value
  • Type:AreaStyle
  • Description:This method returns an AreaStyle.
Parameters
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter specifies the GeoPen you want to use on the outline of the area style.
  • baseColor
    • Type:GeoColor
    • Description:The base GeoColor of the hue family colors.
  • numberOfColors
    • Type:Int32
    • Description:The number of GeoColors in hue family to construct the areastyle.

CreateHueFamilyLinearGradientAreaStyle(GeoColor,GeoColor,Int32,GeoColor,GeoColor,Single)

  • N/A
Remarks
  • None.
Return Value
  • Type:AreaStyle
  • Description:This method returns an AreaStyle in a family of hue-related colors drawn with a linear gradient.
Parameters
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter specifies the GeoPen you want to use on the outline of the AreaStyle.
  • baseColor
    • Type:GeoColor
    • Description:The base GeoColor for the hue family of colors.
  • numberOfColors
    • Type:Int32
    • Description:The number of GeoColors in the hue family to construct the AreaStyle.
  • fromColor
    • Type:GeoColor
    • Description:This parameter represents the starting GeoColor for the gradient.
  • toColor
    • Type:GeoColor
    • Description:This parameter represents the ending GeoColor for the gradient.
  • angle
    • Type:Single
    • Description:This parameter represents the angle for the gradient.

CreateQualityFamilyAreaStyle(GeoColor,GeoColor,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:AreaStyle
  • Description:This method returns an AreaStyle in a family of quality-realted colors.
Parameters
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter specifies the GeoPen you want to use on the outline of the AreaStyle.
  • baseColor
    • Type:GeoColor
    • Description:The base GeoColor for the quality family of colors.
  • numberOfColors
    • Type:Int32
    • Description:The number of GeoColors in the quality-based family to construct the AreaStyle.

CreateQualityFamilyLinearGradientAreaStyle(GeoColor,GeoColor,Int32,GeoColor,GeoColor,Single)

  • N/A
Remarks
  • None.
Return Value
  • Type:AreaStyle
  • Description:This method returns an AreaStyle in a family of quality-related colors drawn with a linear gradient.
Parameters
  • outlinePenColor
    • Type:GeoColor
    • Description:This parameter specifies the GeoPen you want to use on the outline of the AreaStyle.
  • baseColor
    • Type:GeoColor
    • Description:The base GeoColor for the quality family of colors.
  • numberOfColors
    • Type:Int32
    • Description:The number of GeoColors in quality-based family to construct the AreaStyle.
  • fromColor
    • Type:GeoColor
    • Description:This parameter represents the starting GeoColor for the gradient.
  • toColor
    • Type:GeoColor
    • Description:This parameter represents the ending GeoColor for the gradient.
  • angle
    • Type:Single
    • Description:This parameter represents the angle for the gradient.

Protected Methods

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

  • N/A
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:Void
  • Description:None
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter represents the features you want to draw on the view.
  • canvas
    • Type:GeoCanvas
    • Description:This parameter represents the view you want to draw the features on.
  • labelsInThisLayer
    • Type:Collection<SimpleCandidate>
    • Description:The labels will be drawn in the current layer only.
  • labelsInAllLayers
    • Type:Collection<SimpleCandidate>
    • Description:The labels will be drawn in all layers.

DrawSampleCore(GeoCanvas,DrawingRectangleF)

  • N/A
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:Void
  • Description:None
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter represents the view you want to draw the features on.

CloneDeepCore()

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

GetRequiredColumnNamesCore()

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

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

Parse(JObject)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • jObject

Public Properties

XOffsetInPixel

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

YOffsetInPixel

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

FillBrush

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

CustomAreaStyles

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

OutlinePen

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

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

DrawingLevel

  • N/A
Remarks
  • N/A
Return Value

Name

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

IsActive

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

RequiredColumnNames

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

Filters

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

Protected Properties

Shadow

  • N/A
Remarks
  • N/A
Return Value

IsDefault

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

FiltersCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

Public Events

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