BuildingAreaStyle¶

Namespace: ThinkGeo.Core

Represents the BuildingAreaStyle class.

public class BuildingAreaStyle : AreaStyle

Inheritance Object → Style → AreaStyle → BuildingAreaStyle

Properties¶

HeightUnit¶

Gets or sets the HeightUnit.

public DistanceUnit HeightUnit { get; set; }

Property Value¶

DistanceUnit

HeightColumnName¶

Gets or sets the HeightColumnName.

public string HeightColumnName { get; set; }

Property Value¶

String

LightSideBrush¶

Gets or sets the LightSideBrush.

public GeoBrush LightSideBrush { get; set; }

Property Value¶

GeoBrush

ShadowSideBrush¶

Gets or sets the ShadowSideBrush.

public GeoBrush ShadowSideBrush { get; set; }

Property Value¶

GeoBrush

RoofBrush¶

Gets or sets the RoofBrush.

public GeoBrush RoofBrush { get; set; }

Property Value¶

GeoBrush

ShadowMode¶

Gets or sets the ShadowMode.

public BuildingShadowMode ShadowMode { get; set; }

Property Value¶

BuildingShadowMode

XOffsetInPixel¶

This property gets and sets the X pixel offset for drawing each feature.

public float XOffsetInPixel { get; set; }

Property Value¶

Single
This property gets 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.

YOffsetInPixel¶

This property gets and sets the Y pixel offset for drawing each feature.

public float YOffsetInPixel { get; set; }

Property Value¶

Single
This property gets 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.

FillBrush¶

This property gets and sets the solid brush you want to use to fill in the area features.

public GeoBrush FillBrush { get; set; }

Property Value¶

GeoBrush

        This property represents the solid brush you want to use to fill in the area

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.

CustomAreaStyles¶

This property returns a collection of area styles, allowing you to stack multiple area styles on top of each other.

public Collection<AreaStyle> CustomAreaStyles { get; }

Property Value¶

Collection<AreaStyle>
This property returns a collection of area styles.

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.

OutlinePen¶

This property gets and sets the outline pen you want to use to outline the features.

public GeoPen OutlinePen { get; set; }

Property Value¶

GeoPen

        This property gets the outline pen you want to use to outline the

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.

PenBrushDrawingOrder¶

This property gets and sets the pen and brush drawing order.

public PenBrushDrawingOrder PenBrushDrawingOrder { get; set; }

Property Value¶

PenBrushDrawingOrder
This property gets 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.

DrawingLevel¶

Gets or sets the drawing level used when rendering the area style.

public DrawingLevel DrawingLevel { get; set; }

Property Value¶

DrawingLevel

Name¶

This property gets and set the name of the style.

public string Name { get; set; }

Property Value¶

String
This property gets 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.

IsActive¶

This property gets and sets the active status of the style.

public bool IsActive { get; set; }

Property Value¶

Boolean
This property gets the active status of the style.

Remarks:

If the style is not active then it will not draw.

RequiredColumnNames¶

This property gets the collection of fields that are required for the style.

public Collection<string> RequiredColumnNames { get; }

Property Value¶

Collection<String>

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.

Filters¶

Gets the list of SQL-style filters applied to this style.

public Collection<string> Filters { get; }

Property Value¶

Collection<String>

LabelDisplayMode¶

Gets the current label display mode that determines whether labels, shapes, or both are rendered.

public LabelDisplayMode LabelDisplayMode { get; }

Property Value¶

LabelDisplayMode

Constructors¶

BuildingAreaStyle()¶

Initializes a new instance of the BuildingAreaStyle class.

public BuildingAreaStyle()

BuildingAreaStyle(String, DistanceUnit)¶

Initializes a new instance of the BuildingAreaStyle class.

public BuildingAreaStyle(string heightColumnName, DistanceUnit heightUnit)

Parameters¶

heightColumnName String

heightUnit DistanceUnit

Methods¶

GetRequiredColumnNamesCore()¶

Provides the overridable implementation that returns required column names from the underlying data source.

protected Collection<string> GetRequiredColumnNamesCore()

Returns¶

Collection<String>
The result of the operation.

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

Provides the overridable implementation that draws onto and appends any label candidates to .

protected void DrawCore(IEnumerable<Feature> features, GeoCanvas canvas, Collection<SimpleCandidate> labelsInThisLayer, Collection<SimpleCandidate> labelsInAllLayers)

Parameters¶

features IEnumerable<Feature>
The features.

canvas GeoCanvas
The to draw to.

labelsInThisLayer Collection<SimpleCandidate>
The labels in this layer.

labelsInAllLayers Collection<SimpleCandidate>
A shared collection that receives label candidates generated during drawing.

GetHeightInMeters(Feature)¶

Returns height in meters for .

protected double GetHeightInMeters(Feature feature)

Parameters¶

feature Feature
The feature.

Returns¶

Double
The result of the operation.