Builder for a MGRS grid setting. More...

Inheritance diagram for Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder:

Public Member Functions
	Builder (Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder other)

Luciad.Layers.Grids.Mgrs.MgrsGridSetting	Build ()
	Returns the MGRS grid setting. More...

void	Dispose ()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	LabelEdgeOffset (double labelEdgeOffset)
	This specifies the offset of the label, away from the edges of the view, in device independent pixels. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	LabelFormat (string labelFormat)
	The format pattern to use for the labels of the current MGRS. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	LabelGridOffset (double labelGridOffset)
	This specifies the offset of the label, in device independent pixels, away from the grid line to which it is attached. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	LabelOrientation (Luciad.Layers.Grids.Labels.GridLabelOrientation labelOrientation)
	This specifies the label orientation with respect to the line. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	LabelPosition (Luciad.Layers.Grids.Labels.GridLabelPosition labelPosition)
	This specifies the label position with respect to the view. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	LabelStyle (Luciad.Text.TextStyle labelStyle)
	Indicates the label style to use for this setting. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	Level (Luciad.Grids.Mgrs.MgrsLevel level)
	Indicates the MGRS level for which this setting applies. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	LineLabelPosition (Luciad.Layers.Grids.Labels.GridLineLabelPosition lineLabelPosition)
	This specifies the label position (with respect to the line) to use for the line labels of the current MGRS type/level/interval combination. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	LineStyle (Luciad.Layers.Styles.LineStyle lineStyle)
	Indicates the line style to use for this setting. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	ScaleRange (Luciad.Maps.MapScale minScale, Luciad.Maps.MapScale maxScale)
	Indicates the scale range for which this setting applies. More...

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder	Type (Luciad.Grids.Mgrs.MgrsType type)
	Indicates the MGRS type for which this setting applies. More...

Detailed Description

Builder for a MGRS grid setting.

2023.1

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

Constructor & Destructor Documentation

◆ Builder()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.Builder ( Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder other )

inline

Member Function Documentation

◆ Build()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.Build ( )

inline

Returns the MGRS grid setting.

Mandatory parameters: level scale range

Other parameters are optional. the MGRS grid setting.

luciad::LogicException

when not all mandatory parameters are set.

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

◆ Dispose()

void Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.Dispose ( )

inline

◆ LabelEdgeOffset()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.LabelEdgeOffset ( double labelEdgeOffset )

inline

This specifies the offset of the label, away from the edges of the view, in device independent pixels.

It is applied for the labels of the current MGRS type/level/interval combination. This is optional. Defaults to 6.

labelEdgeOffset

the edge offset value. Must be >= 0.

this builder.

luciad::InvalidArgumentException

when an invalid value is passed.

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

◆ LabelFormat()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.LabelFormat ( string labelFormat )

inline

The format pattern to use for the labels of the current MGRS.

This pattern can be used to specify MGRS coordinates or UTM/UPS coordinates. The format in BNF notation (expressions enclosed in [] brackets are optional, expressions enclosed in {} brackets may be omitted or repeated): <pattern> ::= [<zone>] [<separator> <band>] [<coordinates>] <zone> ::= "Z" <band> ::= "B" <coordinates> ::= <mgrs_coordinates> | <utm_coordinates> <mgrs_coordinates> ::= [<separator> <id100k>] [<separator> <x> <separator> <y>] <utm_coordinates> ::= [<separator> <u> <separator> <v>] <id100k> ::= "S" <x> ::= "X" <mgrs_precision> <y> ::= "Y" <mgrs_precision> <mgrs_precision> ::= "0" | "1" | "2" | "3" | "4" | "5" <u> ::= "U" <utm_precision> <v> ::= "V" <utm_precision> <utm_precision> ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" <separator> ::= { ? any character ? } For example:

"33UES 12345 54321" has format "ZBS X5 Y5"

"33U 123456 7654321" has format "ZB U6 V7"

Depending on the label, only some parts of the format string will be used. For example, when displaying grid line labels, only the X or Y part of the format string will be used (e.g. it can be used to specify if "12345" or "1234" is displayed). It is applied for the labels of the current MGRS type/level/interval combination. This is optional. When not specified a default label format is used, depending on the level.

labelFormat

the label format.

this builder.

luciad::InvalidArgumentException

when an invalid value is passed.

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

◆ LabelGridOffset()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.LabelGridOffset ( double labelGridOffset )

inline

This specifies the offset of the label, in device independent pixels, away from the grid line to which it is attached.

It is applied for the labels of the current MGRS type/level/interval combination. This is optional. Defaults to 3.

labelGridOffset

the grid offset value. Must be >= 0.

this builder.

luciad::InvalidArgumentException

when an invalid value is passed.

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

◆ LabelOrientation()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.LabelOrientation ( Luciad.Layers.Grids.Labels.GridLabelOrientation labelOrientation )

inline

This specifies the label orientation with respect to the line.

It is applied for the labels of the current MGRS type/level/interval combination. This is optional. Defaults to AlongLine.

labelOrientation

the label orientation.

this builder.

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

◆ LabelPosition()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.LabelPosition ( Luciad.Layers.Grids.Labels.GridLabelPosition labelPosition )

inline

This specifies the label position with respect to the view.

They can for example be placed at the left or at the right edge of the view. For example, when a label is placed at the east or south side of a line, it is placed at the left or lower edge of the view when using a rectangular projection like Mercator. It is applied for the labels of the current MGRS type/level/interval combination. This is optional. Defaults to WestAndSouth.

labelPosition

the label position.

this builder.

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

◆ LabelStyle()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.LabelStyle ( Luciad.Text.TextStyle labelStyle )

inline

Indicates the label style to use for this setting.

This is optional. Defaults to a white text style with font size 14 and a black halo.

labelStyle

the label style.

this builder.

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

◆ Level()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.Level ( Luciad.Grids.Mgrs.MgrsLevel level )

inline

Indicates the MGRS level for which this setting applies.

This is mandatory.

level

the MGRS level.

this builder.

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

◆ LineLabelPosition()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.LineLabelPosition ( Luciad.Layers.Grids.Labels.GridLineLabelPosition lineLabelPosition )

inline

This specifies the label position (with respect to the line) to use for the line labels of the current MGRS type/level/interval combination.

They can for example be placed at the left or at the right of the line. It is applied for the labels of the current MGRS type/level/interval combination. This is optional. Defaults to AboveOrLeft.

lineLabelPosition

the line label position.

this builder.

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

◆ LineStyle()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.LineStyle ( Luciad.Layers.Styles.LineStyle lineStyle )

inline

Indicates the line style to use for this setting.

This is optional. Defaults to a white line style with width 1.

lineStyle

the line style.

this builder.

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

◆ ScaleRange()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.ScaleRange	(	Luciad.Maps.MapScale	minScale,
		Luciad.Maps.MapScale	maxScale
	)

inline

Indicates the scale range for which this setting applies.

This is mandatory.

minScale

the min scale (most zoomed out).

maxScale

the max scale (most zoomed in).

this builder.

luciad::InvalidArgumentException

when the min scale is larger than or equal to the max scale.

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

◆ Type()

Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder Luciad.Layers.Grids.Mgrs.MgrsGridSetting.Builder.Type ( Luciad.Grids.Mgrs.MgrsType type )

inline

Indicates the MGRS type for which this setting applies.

This is optional. When not called this setting applies to both MGRS types.

type

the MGRS type.

this builder.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Builder()

Member Function Documentation

◆ Build()

◆ Dispose()

◆ LabelEdgeOffset()

◆ LabelFormat()

◆ LabelGridOffset()

◆ LabelOrientation()

◆ LabelPosition()

◆ LabelStyle()

◆ Level()

◆ LineLabelPosition()

◆ LineStyle()

◆ ScaleRange()

◆ Type()