LuciadCPillar C# 2023.1.04
Luciad.Layers.Styles.PinStyle.Builder Class Reference

A builder class for creating pin styles that can be set up to labels, see FeatureCanvas::LabelDrawCommand::pinStyle. More...

Inheritance diagram for Luciad.Layers.Styles.PinStyle.Builder:

Public Member Functions

 Builder (Luciad.Layers.Styles.PinStyle.Builder other)
 
Luciad.Layers.Styles.PinStyle Build ()
 Returns a newly created pin style, based on the properties set on this builder. More...
 
void Dispose ()
 
Luciad.Layers.Styles.PinStyle.Builder EndPosition (Luciad.Layers.Styles.PinStyle.EndPosition endPosition)
 The pin's end position defines where the pin connects to the label. More...
 
Luciad.Layers.Styles.PinStyle.Builder LineStyle (Luciad.Layers.Styles.LineStyle lineStyle)
 Sets the line style used to paint the pin line. More...
 
Luciad.Layers.Styles.PinStyle.Builder VisibilityThreshold (double visibilityThreshold)
 Sets the number of pixels that determine the visibility of a pin line. More...
 

Detailed Description

A builder class for creating pin styles that can be set up to labels, see FeatureCanvas::LabelDrawCommand::pinStyle.

2020.2

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::PinStyle::Builder.

Constructor & Destructor Documentation

◆ Builder()

Luciad.Layers.Styles.PinStyle.Builder.Builder ( Luciad.Layers.Styles.PinStyle.Builder  other)
inline

Member Function Documentation

◆ Build()

Luciad.Layers.Styles.PinStyle Luciad.Layers.Styles.PinStyle.Builder.Build ( )
inline

Returns a newly created pin style, based on the properties set on this builder.

a newly created pin style.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::PinStyle::Builder::build.

◆ Dispose()

void Luciad.Layers.Styles.PinStyle.Builder.Dispose ( )
inline

◆ EndPosition()

Luciad.Layers.Styles.PinStyle.Builder Luciad.Layers.Styles.PinStyle.Builder.EndPosition ( Luciad.Layers.Styles.PinStyle.EndPosition  endPosition)
inline

The pin's end position defines where the pin connects to the label.

Note that the start position is a position that is chosen on the label's anchor geometry. For example, when a label is attached to a Point geometry the start position is that Point. This property is optional. The default value is MiddleOfBoundsOnEdge.

endPosition

the position where the pin connects to the label

this builder

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::PinStyle::Builder::endPosition.

◆ LineStyle()

Luciad.Layers.Styles.PinStyle.Builder Luciad.Layers.Styles.PinStyle.Builder.LineStyle ( Luciad.Layers.Styles.LineStyle  lineStyle)
inline

Sets the line style used to paint the pin line.

This property is optional. By default, pins use a line style of black color and a width of 1.

lineStyle

a line style

this builder

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::PinStyle::Builder::lineStyle.

◆ VisibilityThreshold()

Luciad.Layers.Styles.PinStyle.Builder Luciad.Layers.Styles.PinStyle.Builder.VisibilityThreshold ( double  visibilityThreshold)
inline

Sets the number of pixels that determine the visibility of a pin line.

If the pin line length is smaller than this value, it will be discarded. This property is optional. The default value is 3 pixels.

visibilityThreshold

The number of pixels that determine the visibility of a pin line, in device independent pixels

this builder

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::PinStyle::Builder::visibilityThreshold.