Skip to content

LineStyle

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
LineStyle()
LineStyle(GeoPen)
LineStyle(GeoPen,GeoPen)
LineStyle(GeoPen,GeoPen,GeoPen)

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
CenterPen GeoPen This property gets and sets the center pen for the line.
CenterPenDrawingLevel DrawingLevel N/A
CustomLineStyles Collection<LineStyle> This property returns a collection of line styles, allowing you to stack multiple line styles on top of each other.
DirectionPointInterval Double N/A
DirectionPointStyle PointStyle N/A
Filters Collection<String> N/A
InnerPen GeoPen This property gets and sets the inner pen for the line.
InnerPenDrawingLevel DrawingLevel N/A
IsActive Boolean N/A
Name String N/A
OuterPen GeoPen This property gets and sets the outer pen for the line.
OuterPenDrawingLevel DrawingLevel N/A
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

Public Methods Summary

Name
CloneDeep()
CreateSimpleLineStyle(GeoColor,Single,Boolean)
CreateSimpleLineStyle(GeoColor,Single,LineDashStyle,Boolean)
CreateSimpleLineStyle(GeoColor,Single,GeoColor,Single,Boolean)
CreateSimpleLineStyle(GeoColor,Single,LineDashStyle,GeoColor,Single,LineDashStyle,Boolean)
CreateSimpleLineStyle(GeoColor,Single,GeoColor,Single,GeoColor,Single,Boolean)
CreateSimpleLineStyle(GeoColor,Single,LineDashStyle,GeoColor,Single,LineDashStyle,GeoColor,Single,LineDashStyle,Boolean)
Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
DrawSample(GeoCanvas,DrawingRectangleF)
DrawSample(GeoCanvas)
Equals(Object)
GetHashCode()
GetRequiredColumnNames()
GetType()
Parse(String)
SaveStyle(String)
SaveStyle(Stream)
ToString()

Protected Methods Summary

Name
CloneDeepCore()
CreateLinePen(String[])
DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
DrawSampleCore(GeoCanvas,DrawingRectangleF)
Finalize()
GetRequiredColumnNamesCore()
MemberwiseClone()
OnDrawingDirectionPoint(DrawingDirectionPointEventArgs)
Parse(JObject)

Public Events Summary

Name Event Arguments Description
DrawingDirectionPoint DrawingDirectionPointEventArgs N/A

Members Detail

Public Constructors

Name
LineStyle()
LineStyle(GeoPen)
LineStyle(GeoPen,GeoPen)
LineStyle(GeoPen,GeoPen,GeoPen)

Protected Constructors

Public Properties

CenterPen

Summary

This property gets and sets the center pen for the line.

Remarks

You can set an inner, outer and center pen to give you a nice effect. The outer pen draws first, and should typically be black and larger then the inner pen. The inner pen draws next, and should be set as the color of the road you want. It should be thinner than the outer pen. The center pen draws last, and is used to represent a centerline in the road. We suggest that you only use the center pen for highways at low zoom level, as the dashed pen has some performance penalties.

Return Value

GeoPen


CenterPenDrawingLevel

Summary

N/A

Remarks

N/A

Return Value

DrawingLevel


CustomLineStyles

Summary

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

Remarks

Using this collection, you can stack multiple styles on top of each other. When we draw the feature, 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<LineStyle>


DirectionPointInterval

Summary

N/A

Remarks

N/A

Return Value

Double


DirectionPointStyle

Summary

N/A

Remarks

N/A

Return Value

PointStyle


Filters

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


InnerPen

Summary

This property gets and sets the inner pen for the line.

Remarks

You can set an inner, outer and center pen to give you a nice effect. The outer pen draws first, and should typically be black and larger then the inner pen. The inner pen draws next, and should be set as the color of the road you want. It should be thinner than the outer pen. The center pen draws last, and is used to represent a centerline in the road. We suggest that you only use the center pen for highways at low zoom level, as the dashed pen has some performance penalties.

Return Value

GeoPen


InnerPenDrawingLevel

Summary

N/A

Remarks

N/A

Return Value

DrawingLevel


IsActive

Summary

N/A

Remarks

N/A

Return Value

Boolean


Name

Summary

N/A

Remarks

N/A

Return Value

String


OuterPen

Summary

This property gets and sets the outer pen for the line.

Remarks

You can set an inner, outer and center pen to give you a nice effect. The outer pen draws first, and should typically be black and larger then the inner pen. The inner pen draws next, and should be set as the color of the road you want. It should be thinner than the outer pen. The center pen draws last, and is used to represent a centerline in the road. We suggest that you only use the center pen for highways at low zoom level, as the dashed pen has some performance penalties.

Return Value

GeoPen


OuterPenDrawingLevel

Summary

N/A

Remarks

N/A

Return Value

DrawingLevel


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 is useful to allow 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 better 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 an Y offset. When combined with an X offset, it is useful to allow 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 better 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


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

CreateSimpleLineStyle(GeoColor,Single,Boolean)

Summary

This method returns a LineStyle based on the parameters passed in.

Remarks

None

Return Value

Type Description
LineStyle This method returns a LineStyle based on the parameters passed in.

Parameters

Name Type Description
centerlineColor GeoColor N/A
centerlineWidth Single N/A
roundCap Boolean N/A

CreateSimpleLineStyle(GeoColor,Single,LineDashStyle,Boolean)

Summary

This method returns a LineStyle based on the parameters passed in.

Remarks

None

Return Value

Type Description
LineStyle This method returns a LineStyle based on the parameters passed in.

Parameters

Name Type Description
centerlineColor GeoColor This parameter is the center line color.
centerlineWidth Single This paramter is the the center line width.
centerlineDashStyle LineDashStyle This parameter is the dash style for the center line.
roundCap Boolean This parameter defines whether you want a rounded end cap.

CreateSimpleLineStyle(GeoColor,Single,GeoColor,Single,Boolean)

Summary

This method returns a LineStyle based on the parameters passed in.

Remarks

None

Return Value

Type Description
LineStyle This method returns a LineStyle based on the parameters passed in.

Parameters

Name Type Description
innerLineColor GeoColor This parameter is the inner line color.
innerLineWidth Single This parameter is the inner line width.
outerLineColor GeoColor This parameter is the outer line color.
outerLineWidth Single This parameter is the outer line width.
roundCap Boolean This parameter defines whether you want a rounded end cap.

CreateSimpleLineStyle(GeoColor,Single,LineDashStyle,GeoColor,Single,LineDashStyle,Boolean)

Summary

This method returns a LineStyle based on the parameters passed in.

Remarks

None

Return Value

Type Description
LineStyle This method returns a LineStyle based on the parameters passed in.

Parameters

Name Type Description
innerLineColor GeoColor This parameter is the inner line color.
innerLineWidth Single This parameter is the inner line width.
innerLineDashStyle LineDashStyle This parameter is the inner line dash style.
outerLineColor GeoColor This parameter is the outer line color.
outerLineWidth Single This parameter is the outer line width.
outerLineDashStyle LineDashStyle This parameter is the outer line dash style.
roundCap Boolean This parameter defines whether you want a rounded end cap.

CreateSimpleLineStyle(GeoColor,Single,GeoColor,Single,GeoColor,Single,Boolean)

Summary

This method returns a LineStyle based on the parameters passed in.

Remarks

None

Return Value

Type Description
LineStyle This method returns a LineStyle based on the parameters passed in.

Parameters

Name Type Description
centerlineColor GeoColor This parameter is the center line color.
centerlineWidth Single This parameter is the center line width.
innerLineColor GeoColor This parameter is the inner line color.
innerLineWidth Single This parameter is the inner line width.
outerLineColor GeoColor This parameter is the outer line color.
outerLineWidth Single This parameter is the outer line width.
roundCap Boolean This parameter defines whether you want a rounded end cap.

CreateSimpleLineStyle(GeoColor,Single,LineDashStyle,GeoColor,Single,LineDashStyle,GeoColor,Single,LineDashStyle,Boolean)

Summary

This method returns a LineStyle based on the parameters passed in.

Remarks

None

Return Value

Type Description
LineStyle This method returns a LineStyle based on the parameters passed in.

Parameters

Name Type Description
centerlineColor GeoColor This parameter is the center line color.
centerlineWidth Single This parameter is the center line width.
centerlineDashStyle LineDashStyle This parameter is the center line dash style.
innerLineColor GeoColor This parameter is the inner line color.
innerLineWidth Single This parameter is the inner line width.
innerLineDashStyle LineDashStyle This parameter is the inner line dash style.
outerLineColor GeoColor This parameter is the outer line color.
outerLineWidth Single This parameter is the outer line width.
outerLineDashStyle LineDashStyle This parameter is the outer line dash style.
roundCap Boolean This parameter defines whether you want a rounded end cap.

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
LineStyle 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

CreateLinePen(String[])

Summary

N/A

Remarks

N/A

Return Value

Type Description
GeoPen N/A

Parameters

Name Type Description
valueExpressions String[] 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

OnDrawingDirectionPoint(DrawingDirectionPointEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
drawingDirectionPointEventArgs DrawingDirectionPointEventArgs N/A

Parse(JObject)

Summary

N/A

Remarks

N/A

Return Value

Type Description
LineStyle N/A

Parameters

Name Type Description
jObject JObject N/A

Public Events

DrawingDirectionPoint

N/A

Remarks

N/A

Event Arguments

DrawingDirectionPointEventArgs