Luciad.Layers.Styles.OnPathLabelStyle.Builder Class Reference

A builder class for creating an OnPathLabelStyle. More...

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

Public Member Functions
	Builder (Luciad.Layers.Styles.OnPathLabelStyle.Builder other)
Luciad.Layers.Styles.OnPathLabelStyle	Build ()
	Returns A newly created style, based on the properties set on this builder. More...
void	Dispose ()
Luciad.Layers.Styles.OnPathLabelStyle.Builder	HorizontalAlignment (Luciad.Drawing.HorizontalAlignment horizontalAlignment)
	Sets The horizontal anchor of the label with respect to the location on the line. More...
Luciad.Layers.Styles.OnPathLabelStyle.Builder	HorizontalOffset (double horizontalOffset)
	Sets the horizontal space between the relative location and the label in device independent pixels. More...
Luciad.Layers.Styles.OnPathLabelStyle.Builder	RelativeLocation (double relativeLocation)
	Sets the relative location of the label along the path. More...
Luciad.Layers.Styles.OnPathLabelStyle.Builder	VerticalOffset (double verticalOffset)
	Sets an additional vertical offset between the location on the line and the label, expressed in device independent pixels. More...
Luciad.Layers.Styles.OnPathLabelStyle.Builder	VerticalPosition (Luciad.Layers.Styles.PathLabelPosition verticalPosition)
	Sets the alignment of the label perpendicular to the line. More...

Detailed Description

A builder class for creating an OnPathLabelStyle.

2021.0

Warning

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

Constructor & Destructor Documentation

Builder()

Luciad.Layers.Styles.OnPathLabelStyle.Builder.Builder ( Luciad.Layers.Styles.OnPathLabelStyle.Builder  other )

inline

Member Function Documentation

Build()

Luciad.Layers.Styles.OnPathLabelStyle Luciad.Layers.Styles.OnPathLabelStyle.Builder.Build ( )

inline

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

A newly created style, based on the properties set on this builder.

Warning

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

Dispose()

void Luciad.Layers.Styles.OnPathLabelStyle.Builder.Dispose ( )

inline

HorizontalAlignment()

Luciad.Layers.Styles.OnPathLabelStyle.Builder Luciad.Layers.Styles.OnPathLabelStyle.Builder.HorizontalAlignment ( Luciad.Drawing.HorizontalAlignment  horizontalAlignment )

inline

Sets The horizontal anchor of the label with respect to the location on the line.

By default the horizontal alignment is HorizontalAlignment::Center. This method only has an effect when Builder::relativeLocation is also called.

horizontalAlignment

The horizontal anchor of the label with respect to the location on the line.

this builder.

Warning

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

HorizontalOffset()

Luciad.Layers.Styles.OnPathLabelStyle.Builder Luciad.Layers.Styles.OnPathLabelStyle.Builder.HorizontalOffset ( double  horizontalOffset )

inline

Sets the horizontal space between the relative location and the label in device independent pixels.

This offset follows the tangent of the curve at the specified location. By default the horizontal offset is 0. This method only has an effect when Builder::relativeLocation is also called.

horizontalOffset

the horizontal space between the relative location and the label in device independent pixels.

this builder.

Warning

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

RelativeLocation()

Luciad.Layers.Styles.OnPathLabelStyle.Builder Luciad.Layers.Styles.OnPathLabelStyle.Builder.RelativeLocation ( double  relativeLocation )

inline

Sets the relative location of the label along the path.

This value should in the interval [0,1]. A value of 0 represents the start of the curve and a value of 1 represents the end of the curve. By default the relative location is 0.5 and the label is placed at the middle of the curve. This method is optional. If this method is not called, the label can be placed anywhere along the path.

relativeLocation

the relative location of the label along the path. This value should in the interval [0,1].

this builder.

Warning

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

VerticalOffset()

Luciad.Layers.Styles.OnPathLabelStyle.Builder Luciad.Layers.Styles.OnPathLabelStyle.Builder.VerticalOffset ( double  verticalOffset )

inline

Sets an additional vertical offset between the location on the line and the label, expressed in device independent pixels.

This offset is applied in the direction determined by Builder::verticalPosition. By default the vertical offset is 0.

verticalOffset

an additional vertical offset between the location on the line and the label, expressed in device independent pixels.

this builder.

Warning

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

VerticalPosition()

Luciad.Layers.Styles.OnPathLabelStyle.Builder Luciad.Layers.Styles.OnPathLabelStyle.Builder.VerticalPosition ( Luciad.Layers.Styles.PathLabelPosition  verticalPosition )

inline

Sets the alignment of the label perpendicular to the line.

For example, if this value is PathLabelPosition::Above, the label is displayed above the curve. By default the vertical position is PathLabelPosition::Center.

verticalPosition

the alignment of the label perpendicular to the line.

this builder.

Warning

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