CBCGPChartLegendCell

Detailed Description

The CBCGPChartLegendCell class implements the functionality of individual legend cell. It encapsulates a BCGPChartCellParams object that defines cell appearance.

A cell can be one of the following enumerated types:

• LCT_KEY - displays series key
• LCT_LABEL - displays series or data point label
• LCT_CHART_NAME - displays related chart name
• LCT_CUSTOM - custom cell (displays custom text). You can override OnCalcCustomCellSize and OnDrawCustomCell to display custom content.

If you wish to display custom content in a "standard" cell, you have to override CalcSize and OnDraw methods.

All "standard" cells are created automatically by parent legend. CBCGPChartLegendCell::UpdateCellParams is called to obtain cell parameters from related charts and series. You can override CBCGPChartLegendVisualObject::OnLegendContentCreated or process BCGM_ON_CHART_LEGEND_CONTENT_CREATED to customize cell appearance, or add new legend entries and cells.

The following example illustrates how to add an entry (legend row) with two custom cells at the top of the legend:

Copy

LRESULT CMyView::OnLegendContentCreated(WPARAM, LPARAM lp)

{

CBCGPChartLegendVisualObject* pLegend = (CBCGPChartLegendVisualObject*) lp;

CBCGPChartLegendEntry* pEntryHead = new CBCGPChartLegendEntry(pLegend);

CBCGPChartLegendCell* pCell1 = new CBCGPChartLegendCell("Head Item");

CBCGPChartLegendCell* pCell2 = new CBCGPChartLegendCell("Head Value");

pEntryHead->AddLegendCell(pCell1);

pEntryHead->AddLegendCell(pCell2);

pLegend->InsertLegendEntry(pEntryHead, 0);

return 0;

}

The following example illustrates how to change fill color, text color and content padding for all cells in column 0:

Copy

LRESULT CLegendTest1View::OnLegendContentCreated(WPARAM, LPARAM lp)

{

CBCGPChartLegendVisualObject* pLegend = (CBCGPChartLegendVisualObject*) lp;

for (int i = 0; i < pLegend->GetLegendEntryCount(); i++)

{

CBCGPChartLegendCell* pCell = pLegend->GetLegendCell(i, 0);

BCGPChartCellParams params = pCell->GetCellParams();

params.m_brTextColor = CBCGPBrush(CBCGPColor::DarkRed);

params.m_brContentFill = CBCGPBrush(CBCGPColor::Yellow);

params.SetContentPadding(CBCGPSize(5, 5));

pCell->SetCellParams(params);

}

return 0;

}