/// <summary>
/// Processes the dynamic chart.
/// </summary>
/// <param name="tableDataSheetName">Name of the table data sheet.</param>
/// <param name="tableData">The table data.</param>
/// <param name="chartModel">The chart model.</param>
/// <returns></returns>
/// <exception cref="ArgumentNullException">chartModel</exception>
private static bool ProcessDynamicChart(string tableDataSheetName, TableData tableData, ChartModel chartModel)
{
if (chartModel == null)
{
throw new ArgumentNullException("chartModel");
}
TempDiagnostics.Output(string.Format("Processing chart in sheet '{0}'", tableDataSheetName));
var seriesFactory = new SeriesFactory(chartModel);
if (seriesFactory.SourceSeriesCount > 0)
{
if (tableData.TreatRowAsSeries == false)
{
// A COLUMN of data represents a series...
// Find the Range that representes the first Axis Data for all of the series...
CompositeRangeReference category1AxisRange = DetermineCategory1AxisRange(tableData, tableData.TreatRowAsSeries, tableDataSheetName);
foreach (TableColumn column in tableData.Columns)
{
// Skip if we are on the category column
if (column.DataRegion.ExcelColumnStart == category1AxisRange.MinColumnIndex)
{
continue;
}
// Get information about the series that will be based on the column
var seriesInfo = new ChartSeriesInfo(column);
// We need a column that has not been actively excluded
if (seriesInfo.BaseOnChartSeriesIndex >= 0 && !seriesInfo.SuppressSeries)
{
// Get the template series or get a copy if already used
OpenXmlCompositeElement clonedSeries = seriesFactory.GetOrCloneSourceSeries(seriesInfo.BaseOnChartSeriesIndex);
//TODO: Allow ability to assign colour palettes (as opposed to colours) to dynamically generated series
Color?seriesColour = seriesInfo.SeriesColour;
if (!seriesColour.HasValue)
{
int useCount = seriesFactory.GetUseCount(seriesInfo.BaseOnChartSeriesIndex);
seriesColour = new Color?((ColourPalette.GetColour(ColourPaletteType.GamTechnicalChartPalette, useCount - 1)));
}
var seriesTextRange = new CompositeRangeReference(new RangeReference(tableDataSheetName,
(uint)column.DataRegion.ExcelRowStart,
(uint)column.DataRegion.ExcelColumnStart));
// Series data is first column only
var seriesValuesRange = new CompositeRangeReference(new RangeReference(tableDataSheetName,
(uint)column.DataRegion.ExcelRowStart + 1,
(uint)column.DataRegion.ExcelColumnStart,
(uint)column.DataRegion.ExcelRowEnd,
(uint)column.DataRegion.ExcelColumnStart));
// Determine data ranges to be used within chart series.
ChartDataRangeInfo dataRangeInfo = new ChartDataRangeInfo
{
SeriesTextRange = seriesTextRange,
CategoryAxisDataRange = category1AxisRange,
SeriesValuesRange = seriesValuesRange,
};
// update all formula on the series
UpdateChartSeriesDataReferences(clonedSeries, dataRangeInfo, new SolidColorBrush(seriesColour.Value));
}
}
}
else
{
// A ROW of data represents a series...
// Find the Range that representes the first Axis Data for all of the series...
CompositeRangeReference category1AxisRange = DetermineCategory1AxisRange(tableData, tableData.TreatRowAsSeries, tableDataSheetName);
TableColumn seriesTextColumn = tableData.Columns[FindNonExcludedColumnIndex(tableData, 1)];
// Build a list of columns to include in the series
var seriesTableColumns = new List <TableColumn>();
int seriesValuesColumnIndex = FindNonExcludedColumnIndex(tableData, 2);
TableColumn firstSeriesValuesColumn = tableData.Columns[seriesValuesColumnIndex];
seriesTableColumns.Add(firstSeriesValuesColumn);
// Count up to last column, excluding those marked for exclusion
while (seriesValuesColumnIndex < (tableData.Columns.Count - 1))
{
seriesValuesColumnIndex++;
TableColumn tableColumn = tableData.Columns[seriesValuesColumnIndex];
ChartExcludeOption excludeOption = tableColumn.ChartOptions.GetOptionOrDefault <ChartExcludeOption>();
if (excludeOption == null || excludeOption.Exclude == false)
{
seriesTableColumns.Add(tableColumn);
}
}
foreach (TableDataRowInfo rowInfo in tableData.RowData)
{
// Extract chart series related properties from row data
var seriesInfo = new ChartSeriesInfo(rowInfo.RowData);
// Determine where data has been written into Excel
uint rowIndex = (uint)tableData.MapContainer.ExcelRowStart + rowInfo.TableRowIndex - 1;
// Skip if we are on the category column
if (rowIndex == category1AxisRange.MinRowIndex)
{
continue;
}
// We need a column that has not been actively excluded
if (seriesInfo.BaseOnChartSeriesIndex >= 0 && !seriesInfo.SuppressSeries)
{
// Get the template series or get a copy if already used
OpenXmlCompositeElement clonedSeries = seriesFactory.GetOrCloneSourceSeries(seriesInfo.BaseOnChartSeriesIndex);
//TODO: Allow ability to assign colour palettes (as opposed to colours) to dynamically generated series
Color?seriesColour = seriesInfo.SeriesColour;
if (!seriesColour.HasValue)
{
int useCount = seriesFactory.GetUseCount(seriesInfo.BaseOnChartSeriesIndex);
seriesColour = new Color?((ColourPalette.GetColour(ColourPaletteType.GamTechnicalChartPalette, useCount - 1)));
}
// SeriesText is the series heading used in legends
var seriesTextRange = new CompositeRangeReference(new RangeReference(tableDataSheetName,
rowIndex,
(uint)seriesTextColumn.DataRegion.ExcelColumnStart));
// From column after category to last column in table.
var seriesValuesRange = new CompositeRangeReference();
foreach (TableColumn tableColumn in seriesTableColumns)
{
seriesValuesRange.Update(tableDataSheetName,
rowIndex,
(uint)tableColumn.DataRegion.ExcelColumnStart,
rowIndex,
(uint)tableColumn.DataRegion.ExcelColumnStart);
}
// Determine data ranges to be used within chart series.
ChartDataRangeInfo dataRangeInfo = new ChartDataRangeInfo
{
SeriesTextRange = seriesTextRange,
CategoryAxisDataRange = category1AxisRange,
SeriesValuesRange = seriesValuesRange,
};
// update all formula on the series ( I know we're constantly swapping between brush and color here.... Address later)
UpdateChartSeriesDataReferences(clonedSeries, dataRangeInfo, new SolidColorBrush(seriesColour.Value));
}
}
}
// Remove all un-used template series and set the order of remaining.
uint seriesIndex = 0;
for (int idx = 0; idx < seriesFactory.SourceSeriesCount; idx++)
{
OpenXmlCompositeElement templateSeries = seriesFactory.GetSourceSeriesElement(idx);
// Value is the use-count, if zero then the template needs removing.
if (seriesFactory.GetUseCount(idx) == 0)
{
// Remove the template series.
templateSeries.Remove();
}
else
{
// Set template series index and order to initial value, then set clones
var templateIndex = templateSeries.Descendants <DrawingCharts.Index>().FirstOrDefault();
if (templateIndex != null)
{
templateIndex.Val = seriesIndex;
}
var templateOrder = templateSeries.Descendants <DrawingCharts.Order>().FirstOrDefault();
if (templateOrder != null)
{
templateOrder.Val = seriesIndex;
}
seriesIndex++;
OpenXmlElement lastElement = templateSeries;
foreach (var clonedElement in seriesFactory.GetClonedSeriesElements(idx))
{
var index = clonedElement.Descendants <DrawingCharts.Index>().FirstOrDefault();
if (index != null)
{
index.Val = seriesIndex;
}
var order = clonedElement.Descendants <DrawingCharts.Order>().FirstOrDefault();
if (order != null)
{
order.Val = seriesIndex;
}
lastElement.InsertAfterSelf <OpenXmlElement>(clonedElement);
lastElement = clonedElement;
seriesIndex++;
}
}
}
}
return(true);
}
/// <summary>
/// Updates the supplied series in a chart with range related information.
/// </summary>
/// <param name="chartSeries">The OpenXml representation of the chart which is to be updated</param>
/// <param name="dataRangeInfo">Information relating to the category, axis and series data ranges.</param>
/// <param name="seriesBrush">The brush which will be used when creating the series in the chart.</param>
private static void UpdateChartSeriesDataReferences(OpenXmlCompositeElement chartSeries, ChartDataRangeInfo dataRangeInfo, Brush seriesBrush)
{
SeriesType seriesType = GetSeriesType(chartSeries);
switch (seriesType)
{
case SeriesType.Line:
{
// Update series to match Excel document (leave series index/order 0 as will be set later)
chartSeries.UpdateCategoryValueChartSeries((uint)0, // Series Index
dataRangeInfo.SeriesTextRange,
dataRangeInfo.CategoryAxisDataRange,
dataRangeInfo.SeriesValuesRange);
chartSeries.UpdateLineBrush(seriesBrush);
break;
}
case SeriesType.Pie:
{
// Update series to match Excel document (leave series index/order 0 as will be set later)
chartSeries.UpdateCategoryValueChartSeries((uint)0, // Series Index
dataRangeInfo.SeriesTextRange,
dataRangeInfo.CategoryAxisDataRange,
dataRangeInfo.SeriesValuesRange);
//TODO: Update based on the value, not the series....
// chartSeries.UpdateLineBrush(seriesBrush);
break;
}
case SeriesType.Scatter:
{
chartSeries.UpdateSeriesMarkerBrush(seriesBrush);
// if the scatter has a trendline then update its brush to match
var trendline = chartSeries.Descendants <DrawingCharts.Trendline>().FirstOrDefault();
if (trendline != null)
{
trendline.UpdateLineBrush(seriesBrush);
}
((DrawingCharts.ScatterChartSeries)chartSeries).UpdateXYValueChartSeries((uint)0, // Series Index
dataRangeInfo.SeriesTextRange, // Category Axis column Index
dataRangeInfo.CategoryAxisDataRange, // Data Column Index
dataRangeInfo.SeriesValuesRange);
break;
}
}
}
