Simple Labeling

The Simple Labeling specifies how features must be labeled.

Supported options are:

Property	Description
LabelAttribute	Specifies attribute name to be used as a source of labels.
LabelExpression	Provides a way to customize and format label text. Overrides LabelAttribute
FontFamily	Specifies font family to use to render text. The default is system dependent value.
FontStyle	Style to apply to text. - FontStyle.Regular - regular text. - FontStyle.Bold - bold text. - FontStyle.Italic - italic text. - FontStyle.Underine - underlined text. - FontStyle.StrikeOut - text with a line through the middle.
FontSize	Specifies size of the text.
FontColor	Determines color of the text.
HaloSize	Determines a size of the halo (or outline) around the text.
HaloColor	Determines color of the halo around the text.
GeometryExpression	Geometry expression to be used to transform geometries before passing it to the labeling engine.
MultipartMode	Specifies rendering behavior for multipart geometries. - MultipartMode.All - place a label near every part of the geometry. - MultipartMode.Any - place one label near any part of the geometry. - MultipartMode.Largest - place a label near the largest part of the geometry.
Placement	Specifies how labels are placed relatively to the geometry. - PointLabelPlacement - places label near the center of the geometry. - LineLabelPlacement - places label along the geometry or its perimeter.
Priority	Specifies priority of the label in case if it overlaps with other label. The label with lower priority is not rendered. Default is 1000.

Examples

Points Labeling Examples

By default SimpleLabeling draws text over points:

	// For complete examples and data files, please go to https://github.com/aspose-gis/Aspose.GIS-for-.NET
	using (var map = new Map(500, 200))
	{
	var symbol = new SimpleMarker
	{
	FillColor = Color.LightGray,
	StrokeStyle = StrokeStyle.None
	};

	var labeling = new SimpleLabeling(labelAttribute: "name");

	map.Add(VectorLayer.Open(dataDir + "points.geojson", Drivers.GeoJson), symbol, labeling);
	map.Padding = 50;
	map.Render(dataDir + "points_labeling_out.svg", Renderers.Svg);
	}

view raw Examples-CSharp-Rendering-LabelMap-PointsLabeling.cs hosted with ❤ by GitHub

Here’s how to style font:

	// For complete examples and data files, please go to https://github.com/aspose-gis/Aspose.GIS-for-.NET
	using (var map = new Map(500, 200))
	{
	var symbol = new SimpleMarker
	{
	FillColor = Color.LightGray,
	StrokeStyle = StrokeStyle.None
	};

	var labeling = new SimpleLabeling(labelAttribute: "name")
	{
	HaloSize = 2,
	HaloColor = Color.LightGray,
	FontSize = 15,
	FontStyle = FontStyle.Italic,
	};

	map.Add(VectorLayer.Open(dataDir + "points.geojson", Drivers.GeoJson), symbol, labeling);
	map.Padding = 50;
	map.Render(dataDir + "points_labeling_styled_out.svg", Renderers.Svg);
	}

view raw Examples-CSharp-Rendering-LabelMap-PointsLabelingStyled.cs hosted with ❤ by GitHub

In order to control text position relatively to point feature, placement property must be set:

	// For complete examples and data files, please go to https://github.com/aspose-gis/Aspose.GIS-for-.NET
	using (var map = new Map(500, 200))
	{
	var symbol = new SimpleMarker
	{
	FillColor = Color.LightGray,
	StrokeStyle = StrokeStyle.None
	};

	var labeling = new SimpleLabeling(labelAttribute: "name")
	{
	HaloSize = 1,
	Placement = new PointLabelPlacement
	{
	VerticalAnchorPoint = VerticalAnchor.Bottom,
	HorizontalAnchorPoint = HorizontalAnchor.Left,
	HorizontalOffset = 2,
	VerticalOffset = 2,
	Rotation = 10,
	}
	};

	map.Add(VectorLayer.Open(dataDir + "points.geojson", Drivers.GeoJson), symbol, labeling);
	map.Padding = 50;
	map.Render(dataDir + "points_labeling_placed_out.svg", Renderers.Svg);
	}

view raw Examples-CSharp-Rendering-LabelMap-PointsLabelingPlaced.cs hosted with ❤ by GitHub

For more advanced scenarios, you might want to choose different labelings for features. Here’s how to do that:

	// For complete examples and data files, please go to https://github.com/aspose-gis/Aspose.GIS-for-.NET
	using (var map = new Map(500, 200))
	{
	var symbolizer = new SimpleMarker {FillColor = Color.LightGray, StrokeStyle = StrokeStyle.None};

	var labeling = new RuleBasedLabeling();
	// Set labeling to be used for small cities.
	labeling.Add(f => f.GetValue<int>("population") <= 2500, new SimpleLabeling("name")
	{
	FontStyle = FontStyle.Italic,
	HaloSize = 1,
	FontSize = 10,
	FontColor = Color.Green,
	Priority = 1,
	Placement = new PointLabelPlacement
	{
	VerticalAnchorPoint = VerticalAnchor.Bottom,
	HorizontalAnchorPoint = HorizontalAnchor.Center,
	}
	});
	// Set labeling to be used for all other cities.
	labeling.AddElseRule(new SimpleLabeling("name")
	{
	HaloSize = 1,
	FontSize = 15,
	FontColor = Color.Red,
	Priority = 2,
	Placement = new PointLabelPlacement
	{
	VerticalAnchorPoint = VerticalAnchor.Bottom,
	HorizontalAnchorPoint = HorizontalAnchor.Center,
	}
	});

	map.Add(VectorLayer.Open(dataDir + "points.geojson", Drivers.GeoJson), symbolizer, labeling);
	map.Padding = 40;
	map.Render(dataDir + "rule_based_labeling_out.svg", Renderers.Svg);
	}

view raw Examples-CSharp-Rendering-LabelMap-RuleBasedLabeling.cs hosted with ❤ by GitHub

Lines Labeling Examples

By default SimpleLabeling draws label near center of the line:

	// For complete examples and data files, please go to https://github.com/aspose-gis/Aspose.GIS-for-.NET
	using (var map = new Map(1000, 634))
	{
	var symbolizer = new SimpleLine { Width = 1.5, Color = Color.FromArgb(0xAE, 0xD9, 0xFD) };

	var labeling = new SimpleLabeling(labelAttribute: "name");

	map.Add(VectorLayer.Open(dataDir + "lines.geojson", Drivers.GeoJson), symbolizer, labeling);
	map.Padding = 50;
	map.Render(dataDir + "lines_labeling_out.svg", Renderers.Svg);
	}

view raw Examples-CSharp-Rendering-LabelMap-LinesLabeling.cs hosted with ❤ by GitHub

In order to rotate labels so they are parallel to lines, LineLabelPlacement with LineLabelAlignment.Parallel can be used:

	// For complete examples and data files, please go to https://github.com/aspose-gis/Aspose.GIS-for-.NET
	using (var map = new Map(1000, 634))
	{
	var symbolizer = new SimpleLine { Width = 1.5, Color = Color.FromArgb(0xAE, 0xD9, 0xFD) };

	var labeling = new SimpleLabeling(labelAttribute: "name")
	{
	HaloSize = 1,
	Placement = new LineLabelPlacement
	{
	Alignment = LineLabelAlignment.Parallel,
	}
	};

	map.Add(VectorLayer.Open(dataDir + "lines.geojson", Drivers.GeoJson), symbolizer, labeling);
	map.Padding = 50;
	map.Render(dataDir + "lines_labeling_parallel_out.svg", Renderers.Svg);
	}

view raw Examples-CSharp-Rendering-LabelMap-LinesLabelingParallel.cs hosted with ❤ by GitHub

If you want texts to follow line precisely, LineLabelPlacement with LineLabelAlignment.Curved can be used:

	// For complete examples and data files, please go to https://github.com/aspose-gis/Aspose.GIS-for-.NET
	using (var map = new Map(1000, 634))
	{
	var symbolizer = new SimpleLine { Width = 1.5, Color = Color.FromArgb(0xAE, 0xD9, 0xFD) };

	var labeling = new SimpleLabeling(labelAttribute: "name")
	{
	HaloSize = 1,
	Placement = new LineLabelPlacement
	{
	Alignment = LineLabelAlignment.Curved,
	}
	};

	map.Add(VectorLayer.Open(dataDir + "lines.geojson", Drivers.GeoJson), symbolizer, labeling);
	map.Padding = 50;
	map.Render(dataDir + "lines_labeling_curved_out.svg", Renderers.Svg);
	}

view raw Examples-CSharp-Rendering-LabelMap-LinesLabelingCurved.cs hosted with ❤ by GitHub

If you don’t want texts to overlap with line, use LineLabelPlacement.Offset:

	// For complete examples and data files, please go to https://github.com/aspose-gis/Aspose.GIS-for-.NET
	using (var map = new Map(1000, 634))
	{
	var symbolizer = new SimpleLine { Width = 1.5, Color = Color.FromArgb(0xAE, 0xD9, 0xFD) };

	var labeling = new SimpleLabeling(labelAttribute: "name")
	{
	HaloSize = 1,
	Placement = new LineLabelPlacement
	{
	Alignment = LineLabelAlignment.Curved,
	Offset = 5,
	}
	};

	map.Add(VectorLayer.Open(dataDir + "lines.geojson", Drivers.GeoJson), symbolizer, labeling);
	map.Padding = 50;
	map.Render(dataDir + "lines_labeling_curved_offset_out.svg", Renderers.Svg);
	}

view raw Examples-CSharp-Rendering-LabelMap-LinesLabelingCurvedWithOffset.cs hosted with ❤ by GitHub

For more advanced scenarios, you might want to adjust the labels style dynamically based on feature attribute values. Here’s how to do that:

	// For complete examples and data files, please go to https://github.com/aspose-gis/Aspose.GIS-for-.NET
	using (var map = new Map(1000, 634))
	{
	var lineSymbolizer = new SimpleLine { Width = 1.5, Color = Color.FromArgb(0xae, 0xd9, 0xfd) };
	lineSymbolizer.FeatureBasedConfiguration = (feature, symbolizer) =>
	{
	if (feature.GetValue<string>("NAM") == "UNK")
	{
	symbolizer.Width = 1;
	symbolizer.Style = StrokeStyle.Dash;
	}
	};


	var lineLabeling = new SimpleLabeling(labelAttribute: "name")
	{
	HaloSize = 1,
	Placement = new LineLabelPlacement
	{
	Alignment = LineLabelAlignment.Parallel,
	},
	FontSize = 20,
	FeatureBasedConfiguration = (feature, labeling) =>
	{
	if (feature.GetValue<string>("NAM") == "UNK")
	{
	// change labeling properties for some features.
	labeling.FontStyle = FontStyle.Italic;
	labeling.FontSize = 10;
	labeling.Priority = -1;

	var placement = (LineLabelPlacement) labeling.Placement;
	placement.Alignment = LineLabelAlignment.Curved;
	placement.Offset = 5;
	}
	}
	};

	map.Add(VectorLayer.Open(dataDir + "lines.geojson", Drivers.GeoJson), lineSymbolizer, lineLabeling);
	map.Padding = 50;
	map.Render(dataDir + "lines_labeling_feature_based_out.svg", Renderers.Svg);
	}

view raw Examples-CSharp-Rendering-LabelMap-LinesLabelingFeatureBased.cs hosted with ❤ by GitHub

Rule-Based Labeling