LabelContainsCategoryName Property (TreemapSeries)

Gets or sets whether the category name is displayed in the labels.

Syntax

Visual Basic
C#

'Declaration
 
Public Property LabelContainsCategoryName As Boolean

'Usage
 
Dim instance As TreemapSeries
Dim value As Boolean
 
instance.LabelContainsCategoryName = value
 
value = instance.LabelContainsCategoryName

public bool LabelContainsCategoryName {get; set;}

Example

This example creates a treemap chart.

FarPoint.Web.Chart.TreemapSeries series = new FarPoint.Web.Chart.TreemapSeries();
series.Values.AddRange(new double[] { 3.5, 1.2, 0.8, 0.6, 0.5, 1.7, 1.1, 0.7, 1.3, 2.0 });
series.Fills.AddRange(new FarPoint.Web.Chart.Fill[] { new FarPoint.Web.Chart.GradientFill(Color.Red, Color.Orange), null, null });
series.Borders.AddRange(new FarPoint.Web.Chart.Line[] { new FarPoint.Web.Chart.SolidLine(Color.Black), null, null, null, null, null, null, null, new FarPoint.Web.Chart.SolidLine(Color.Yellow), null, null, null, null, new FarPoint.Web.Chart.SolidLine(Color.Aqua) });
series.LabelContainsCategoryName = true;
series.LabelContainsValue = true;
series.LabelOption = FarPoint.Web.Chart.LabelOption.Banner;
FarPoint.Web.Chart.StringCollectionItem collection1 = new FarPoint.Web.Chart.StringCollectionItem();
collection1.AddRange(new String[] { "1st", "", "", "", "", "", "2nd", "", "", "3rd" });
FarPoint.Web.Chart.StringCollectionItem collection2 = new FarPoint.Web.Chart.StringCollectionItem();
collection2.AddRange(new String[] { "Jan", "Feb", "", "", "", "Mar", "Apr", "May", "June", "July" });
FarPoint.Web.Chart.StringCollectionItem collection3 = new FarPoint.Web.Chart.StringCollectionItem();
collection3.AddRange(new String[] { "", "Week1", "Week2", "Week3", "Week4", "", "", "", "", "" });
series.CategoryNames.AddRange(new FarPoint.Web.Chart.StringCollectionItem[] { collection1, collection2, collection3 });
FarPoint.Web.Chart.TreemapPlotArea plotArea = new FarPoint.Web.Chart.TreemapPlotArea();
plotArea.Location = new PointF(0.2f, 0.2f);
plotArea.Size = new SizeF(0.6f, 0.6f);
plotArea.Series.Add(series);
FarPoint.Web.Chart.ChartModel model = new FarPoint.Web.Chart.ChartModel();
model.PlotAreas.Add(plotArea);
FarPoint.Web.Spread.Chart.SpreadChart chart = new FarPoint.Web.Spread.Chart.SpreadChart();
chart.Height = 500;
chart.Width = 500;
chart.Model = model;
FpSpread1.Sheets[0].Charts.Add(chart);

Visual Basic

Dim series As New FarPoint.Web.Chart.TreemapSeries()
series.Values.AddRange(New Double() {3.5, 1.2, 0.8, 0.6, 0.5, 1.7, 1.1, 0.7, 1.3, 2.0})
series.Fills.AddRange(New FarPoint.Web.Chart.Fill() {New FarPoint.Web.Chart.GradientFill(Drawing.Color.Red, Drawing.Color.Orange), Nothing, Nothing})
series.Fills.AddRange(New FarPoint.Web.Chart.Fill() {New FarPoint.Web.Chart.GradientFill(Drawing.Color.Red, Drawing.Color.Orange), Nothing, Nothing})
series.Borders.AddRange(New FarPoint.Web.Chart.Line() {New FarPoint.Web.Chart.SolidLine(Drawing.Color.Black), Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, New FarPoint.Web.Chart.SolidLine(Drawing.Color.Yellow), Nothing, Nothing, Nothing, Nothing, New FarPoint.Web.Chart.SolidLine(Drawing.Color.Aqua)})
series.LabelContainsCategoryName = True
series.LabelContainsValue = True
series.LabelOption = FarPoint.Web.Chart.LabelOption.Banner
Dim collection1 As New FarPoint.Web.Chart.StringCollectionItem()
collection1.AddRange(New String() {"1st", "", "", "", "", "", "2nd", "", "", "3rd"})
Dim collection2 As New FarPoint.Web.Chart.StringCollectionItem()
collection2.AddRange(New String() {"Jan", "Feb", "", "", "", "Mar", "Apr", "May", "June", "July"})
Dim collection3 As New FarPoint.Web.Chart.StringCollectionItem()
collection3.AddRange(New String() {"", "Week1", "Week2", "Week3", "Week4", "", "", "", "", ""})
series.CategoryNames.AddRange(New FarPoint.Web.Chart.StringCollectionItem() {collection1, collection2, collection3})
Dim plotArea As New FarPoint.Web.Chart.TreemapPlotArea()
plotArea.Location = New Drawing.PointF(0.2F, 0.2F)
plotArea.Size = New Drawing.SizeF(0.6F, 0.6F)
plotArea.Series.Add(series)
Dim model As New FarPoint.Web.Chart.ChartModel()
model.PlotAreas.Add(plotArea)
Dim chart As New FarPoint.Web.Spread.Chart.SpreadChart()
chart.Width = 500
chart.Height = 500
chart.Model = model
FpSpread1.Sheets(0).Charts.Add(chart)

Requirements

Target Platforms: Windows 7, Windows 8, Windows 10, Windows Vista, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows XP Professional

Reference

TreemapSeries Class
TreemapSeries Members