Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Class Reference

Builder for a LonLat grid. More...

Inheritance diagram for Luciad.Layers.Grids.LonLat.LonLatGrid.Builder:

Public Member Functions
	Builder (Luciad.Layers.Grids.LonLat.LonLatGrid.Builder other)
Luciad.Layers.Grids.LonLat.LonLatGrid	Build ()
	Returns the LonLat grid. More...
void	Dispose ()
Luciad.Layers.Grids.LonLat.LonLatGrid.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.LonLat.LonLatGrid.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.LonLat.LonLatGrid.Builder	LabelOrientation (Luciad.Layers.Grids.Labels.GridLabelOrientation labelOrientation)
	This specifies the label orientation with respect to the line. More...
Luciad.Layers.Grids.LonLat.LonLatGrid.Builder	LabelPosition (Luciad.Layers.Grids.LonLat.LonLatGridLabelPosition labelPosition)
	This specifies the label position with respect to the view. More...
Luciad.Layers.Grids.LonLat.LonLatGrid.Builder	LabelStyle (Luciad.Text.TextStyle labelStyle)
	Indicates the label style to use for the LonLat grid. More...
Luciad.Layers.Grids.LonLat.LonLatGrid.Builder	LineLabelPosition (Luciad.Layers.Grids.Labels.GridLineLabelPosition lineLabelPosition)
	This specifies the label position (with respect to the line) to use for the line labels. More...
Luciad.Layers.Grids.LonLat.LonLatGrid.Builder	LineStyle (Luciad.Layers.Styles.LineStyle lineStyle)
	Indicates the line style to use for the LonLat grid. More...
Luciad.Layers.Grids.LonLat.LonLatGrid.Builder	OriginLabelStyle (Luciad.Text.TextStyle labelStyle)
	Indicates the origin label style to use for the LonLat grid. More...
Luciad.Layers.Grids.LonLat.LonLatGrid.Builder	OriginLat (double originLat)
	Indicates the origin latitude. More...
Luciad.Layers.Grids.LonLat.LonLatGrid.Builder	OriginLineStyle (Luciad.Layers.Styles.LineStyle lineStyle)
	Indicates the origin line style to use for the LonLat grid. More...
Luciad.Layers.Grids.LonLat.LonLatGrid.Builder	OriginLon (double originLon)
	Indicates the origin longitude. More...
Luciad.Layers.Grids.LonLat.LonLatGrid.Builder	ScaleMultiplier (double scaleMultiplier)
	Indicates the scale multiplier to use for the LonLat grid scale ranges. More...

Detailed Description

Builder for a LonLat grid.

Creates a LonLat grid with predefined scale ranges and default (customizable) styling. 2023.1

Warning

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

Constructor & Destructor Documentation

Builder()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.Builder ( Luciad.Layers.Grids.LonLat.LonLatGrid.Builder  other )

inline

Member Function Documentation

Build()

Luciad.Layers.Grids.LonLat.LonLatGrid Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.Build ( )

inline

Returns the LonLat grid.

luciad::LonLatGrid for information on the constraints for a LonLat grid.

the LonLat grid.

luciad::LogicException

when the settings are invalid.

Warning

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

Dispose()

void Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.Dispose ( )

inline

LabelEdgeOffset()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.LabelEdgeOffset ( double  labelEdgeOffset )

inline

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

This is applied to all style settings in the grid. This is optional. Defaults to 6.

labelEdgeOffset

the edge offset value. Must be >= 0.

this builder.

luciad::InvalidArgumentException

when an invalid value is passed.

luciad::LonLatGridSetting::Builder::labelEdgeOffset

Warning

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

LabelGridOffset()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.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.

This is applied to all style settings in the grid. This is optional. Defaults to 3.

labelGridOffset

the grid offset value. Must be >= 0.

this builder.

luciad::InvalidArgumentException

when an invalid value is passed.

luciad::LonLatGridSetting::Builder::labelGridOffset

Warning

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

LabelOrientation()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.LabelOrientation ( Luciad.Layers.Grids.Labels.GridLabelOrientation  labelOrientation )

inline

This specifies the label orientation with respect to the line.

This is applied to all style settings in the grid. This is optional. Defaults to AlongLine.

labelOrientation

the label orientation.

this builder.

luciad::LonLatGridSetting::Builder::labelOrientation

Warning

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

LabelPosition()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.LabelPosition ( Luciad.Layers.Grids.LonLat.LonLatGridLabelPosition  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. This is applied to all style settings in the grid. This is optional. Defaults to AllSides.

labelPosition

the label position.

this builder.

luciad::LonLatGridSetting::Builder::labelPosition

Warning

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

LabelStyle()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.LabelStyle ( Luciad.Text.TextStyle  labelStyle )

inline

Indicates the label style to use for the LonLat grid.

labelStyle

the label style.

this builder.

Warning

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

LineLabelPosition()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.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.

They can for example be placed at the left or at the right of the line. This is applied to all style settings in the grid. This is optional. Defaults to AboveOrLeft.

lineLabelPosition

the line label position.

this builder.

luciad::LonLatGridSetting::Builder::lineLabelPosition

Warning

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

LineStyle()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.LineStyle ( Luciad.Layers.Styles.LineStyle  lineStyle )

inline

Indicates the line style to use for the LonLat grid.

lineStyle

the line style.

this builder.

Warning

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

OriginLabelStyle()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.OriginLabelStyle ( Luciad.Text.TextStyle  labelStyle )

inline

Indicates the origin label style to use for the LonLat grid.

labelStyle

the label style.

this builder.

Warning

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

OriginLat()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.OriginLat ( double  originLat )

inline

Indicates the origin latitude.

This is optional. Defaults to 0.

originLat

the origin latitude.

this builder.

luciad::InvalidArgumentException

when the origin latitude is smaller than -90 or larger than 90.

Warning

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

OriginLineStyle()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.OriginLineStyle ( Luciad.Layers.Styles.LineStyle  lineStyle )

inline

Indicates the origin line style to use for the LonLat grid.

lineStyle

the line style.

this builder.

Warning

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

OriginLon()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.OriginLon ( double  originLon )

inline

Indicates the origin longitude.

This is optional. Defaults to 0.

originLon

the origin longitude.

this builder.

luciad::InvalidArgumentException

when the origin longitude is smaller than -180 or larger than 180.

Warning

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

ScaleMultiplier()

Luciad.Layers.Grids.LonLat.LonLatGrid.Builder Luciad.Layers.Grids.LonLat.LonLatGrid.Builder.ScaleMultiplier ( double  scaleMultiplier )

inline

Indicates the scale multiplier to use for the LonLat grid scale ranges.

The value must be within the range [0.1, 10.0]. A value larger than 1 makes the grid lines appear later when zooming in. This results in a coarser grid. A value below 1 makes the grid lines appear sooner when zooming in. This results in a finer grid.

scaleMultiplier

the scale multiplier.

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::LonLatGrid::Builder::scaleMultiplier.