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

This class contains styling properties that can be used to configure pins for labels, see FeatureCanvas::LabelDrawCommand::pinStyle. More...

Inheritance diagram for Luciad.Layers.Styles.PinStyle:

Classes

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

Public Types

enum  EndPosition { ClosestEdge , ClosestPointOnEdge , MiddleOfBoundsOnEdge }
 Possible positions for the end of the pin. More...
 

Public Member Functions

Luciad.Layers.Styles.PinStyle.Builder AsBuilder ()
 Returns a PinStyle builder that has all properties of this PinStyle. More...
 
void Dispose ()
 
Luciad.Layers.Styles.PinStyle.EndPosition GetEndPosition ()
 

Static Public Member Functions

static Luciad.Layers.Styles.PinStyle.Builder NewBuilder ()
 Returns a new builder for creating a PinStyle. More...
 

Properties

Luciad.Layers.Styles.LineStyle LineStyle [get]
 
double VisibilityThreshold [get]
 

Detailed Description

This class contains styling properties that can be used to configure pins for labels, see FeatureCanvas::LabelDrawCommand::pinStyle.

You can create instances of this class using PinStyle::newBuilder. 2020.2

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

Member Enumeration Documentation

◆ EndPosition

Possible positions for the end of the pin.

This is the location where the pin line connects to the label. 2020.2

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

The pin connects to the label at the middle point of the label's edge that is closest to the label's anchor geometry.

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

The pin connects to the label at the position on any of the label's edges that is closest to the label's anchor geometry.

Note that this can include any of the corners of the label. This end position results in the smallest possible pin lines.

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

The pin connects to the label at the middle of the label bounds.

Additionally pin line is cut off where it crosses the edge of the label.

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

Member Function Documentation

◆ AsBuilder()

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

Returns a PinStyle builder that has all properties of this PinStyle.

a PinStyle builder that has all properties of this PinStyle.

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

◆ Dispose()

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

◆ GetEndPosition()

Luciad.Layers.Styles.PinStyle.EndPosition Luciad.Layers.Styles.PinStyle.GetEndPosition ( )
inline

the location where the pin line connects to the label.

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

◆ NewBuilder()

Luciad.Layers.Styles.PinStyle.Builder Luciad.Layers.Styles.PinStyle.NewBuilder ( )
inlinestatic

Returns a new builder for creating a PinStyle.

a new builder for creating a PinStyle.

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

Property Documentation

◆ LineStyle

Luciad.Layers.Styles.LineStyle Luciad.Layers.Styles.PinStyle.LineStyle
get

◆ VisibilityThreshold

double Luciad.Layers.Styles.PinStyle.VisibilityThreshold
get