Aspose::Words::Drawing::Charts::ChartDataLabelCollection class

ChartDataLabelCollection class

Represents a collection of ChartDataLabel. To learn more, visit the Working with Charts documentation article.

class ChartDataLabelCollection : public System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Words::Drawing::Charts::ChartDataLabel>>,
                                 public Aspose::Words::Drawing::Charts::Core::INumberFormatProvider,
                                 public Aspose::Words::Drawing::Charts::Core::IChartFormatSource

Methods

Method	Description
ClearFormat()	Clears format of all ChartDataLabel in this collection.
get_Count()	Returns the number of ChartDataLabel in this collection.
get_Font()	Provides access to the font formatting of the data labels of the entire series.
get_Format()	Provides access to fill and line formatting of the data labels.
get_NumberFormat()	Gets an ChartNumberFormat instance allowing to set number format for the data labels of the entire series.
get_Orientation()	Gets the text orientation of the data labels of the entire series.
get_Rotation()	Gets or sets the rotation of the data labels of the entire series in degrees.
get_Separator()	Gets or sets string separator used for the data labels of the entire series. The default is a comma, except for pie charts showing only category name and percentage, when a line break shall be used instead.
get_ShowBubbleSize()	Allows to specify whether bubble size is to be displayed for the data labels of the entire series. Applies only to Bubble charts. Default value is false.
get_ShowCategoryName()	Allows to specify whether category name is to be displayed for the data labels of the entire series. Default value is false.
get_ShowDataLabelsRange()	Allows to specify whether values from data labels range to be displayed in the data labels of the entire series. Default value is false.
get_ShowLeaderLines()	Allows to specify whether data label leader lines need be shown for the data labels of the entire series. Default value is false.
get_ShowLegendKey()	Allows to specify whether legend key is to be displayed for the data labels of the entire series. Default value is false.
get_ShowPercentage()	Allows to specify whether percentage value is to be displayed for the data labels of the entire series. Default value is false. Applies only to Pie charts.
get_ShowSeriesName()	Returns or sets a Boolean to indicate the series name display behavior for the data labels of the entire series. true to show the series name; false to hide. By default false.
get_ShowValue()	Allows to specify whether values are to be displayed in the data labels of the entire series. Default value is false.
GetEnumerator() override	Returns an enumerator object.
GetType() const override
idx_get(int32_t)	Returns ChartDataLabel for the specified index.
Is(const System::TypeInfo&) const override
set_Orientation(Aspose::Words::Drawing::ShapeTextOrientation)	Sets the text orientation of the data labels of the entire series.
set_Rotation(int32_t)	Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_Rotation.
set_Separator(const System::String&)	Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_Separator.
set_ShowBubbleSize(bool)	Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowBubbleSize.
set_ShowCategoryName(bool)	Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowCategoryName.
set_ShowDataLabelsRange(bool)	Allows to specify whether values from data labels range to be displayed in the data labels of the entire series. Default value is false.
set_ShowLeaderLines(bool)	Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowLeaderLines.
set_ShowLegendKey(bool)	Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowLegendKey.
set_ShowPercentage(bool)	Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowPercentage.
set_ShowSeriesName(bool)	Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowSeriesName.
set_ShowValue(bool)	Setter for Aspose::Words::Drawing::Charts::ChartDataLabelCollection::get_ShowValue.
static Type()

Examples

Shows how to apply labels to data points in a line chart.

void DataLabels()
{
    auto doc = MakeObject<Document>();
    auto builder = MakeObject<DocumentBuilder>(doc);

    SharedPtr<Shape> chartShape = builder->InsertChart(ChartType::Line, 400, 300);
    SharedPtr<Chart> chart = chartShape->get_Chart();

    ASSERT_EQ(3, chart->get_Series()->get_Count());
    ASSERT_EQ(u"Series 1", chart->get_Series()->idx_get(0)->get_Name());
    ASSERT_EQ(u"Series 2", chart->get_Series()->idx_get(1)->get_Name());
    ASSERT_EQ(u"Series 3", chart->get_Series()->idx_get(2)->get_Name());

    // Apply data labels to every series in the chart.
    // These labels will appear next to each data point in the graph and display its value.
    for (const auto& series : System::IterateOver(chart->get_Series()))
    {
        ApplyDataLabels(series, 4, u"000.0", u", ");
        ASSERT_EQ(4, series->get_DataLabels()->get_Count());
    }

    // Change the separator string for every data label in a series.
    {
        SharedPtr<System::Collections::Generic::IEnumerator<SharedPtr<ChartDataLabel>>> enumerator =
            chart->get_Series()->idx_get(0)->get_DataLabels()->GetEnumerator();
        while (enumerator->MoveNext())
        {
            ASSERT_EQ(u", ", enumerator->get_Current()->get_Separator());
            enumerator->get_Current()->set_Separator(u" & ");
        }
    }

    // For a cleaner looking graph, we can remove data labels individually.
    chart->get_Series()->idx_get(1)->get_DataLabels()->idx_get(2)->ClearFormat();

    // We can also strip an entire series of its data labels at once.
    chart->get_Series()->idx_get(2)->get_DataLabels()->ClearFormat();

    doc->Save(ArtifactsDir + u"Charts.DataLabels.docx");
}

static void ApplyDataLabels(SharedPtr<ChartSeries> series, int labelsCount, String numberFormat, String separator)
{
    for (int i = 0; i < labelsCount; i++)
    {
        series->set_HasDataLabels(true);

        ASSERT_FALSE(series->get_DataLabels()->idx_get(i)->get_IsVisible());

        series->get_DataLabels()->idx_get(i)->set_ShowCategoryName(true);
        series->get_DataLabels()->idx_get(i)->set_ShowSeriesName(true);
        series->get_DataLabels()->idx_get(i)->set_ShowValue(true);
        series->get_DataLabels()->idx_get(i)->set_ShowLeaderLines(true);
        series->get_DataLabels()->idx_get(i)->set_ShowLegendKey(true);
        series->get_DataLabels()->idx_get(i)->set_ShowPercentage(false);
        series->get_DataLabels()->idx_get(i)->set_IsHidden(false);
        ASSERT_FALSE(series->get_DataLabels()->idx_get(i)->get_ShowDataLabelsRange());

        series->get_DataLabels()->idx_get(i)->get_NumberFormat()->set_FormatCode(numberFormat);
        series->get_DataLabels()->idx_get(i)->set_Separator(separator);

        ASSERT_FALSE(series->get_DataLabels()->idx_get(i)->get_ShowDataLabelsRange());
        ASSERT_TRUE(series->get_DataLabels()->idx_get(i)->get_IsVisible());
        ASSERT_FALSE(series->get_DataLabels()->idx_get(i)->get_IsHidden());
    }
}

Aspose::Words::Drawing::Charts::ChartDataLabelCollection class

ChartDataLabelCollection class

Methods

Examples

See Also