aspose.cells

aspose.cells

Class ChartDataTable

Represents a chart data table.

Example:

//Instantiating a Workbook object
$workbook = new cells\Workbook();
//Obtaining the reference of the first worksheet
$worksheet = $workbook->getWorksheets()->get(0);
//Adding a sample value to "A1" cell
$worksheet->getCells()->get("A1")->putValue(50);
//Adding a sample value to "A2" cell
$worksheet->getCells()->get("A2")->putValue(100);
//Adding a sample value to "A3" cell
$worksheet->getCells()->get("A3")->putValue(150);
//Adding a sample value to "B1" cell
$worksheet->getCells()->get("B1")->putValue(60);
//Adding a sample value to "B2" cell
$worksheet->getCells()->get("B2")->putValue(32);
//Adding a sample value to "B3" cell
$worksheet->getCells()->get("B3")->putValue(50);
//Adding a chart to the worksheet
$chartIndex = $worksheet->getCharts()->add(cells\ChartType::COLUMN, 5, 0, 25, 10);
//Accessing the instance of the newly added chart
$chart = $worksheet->getCharts()->get($chartIndex);
//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
$chart->getNSeries()->add("A1:B3", true);
$chart->setShowDataTable(true);
//Getting Chart Table
$chartTable = $chart->getChartDataTable();
//Setting Chart Table Font Color
$chartTable->getFont()->setColor(cells\Color::getRed());
//Setting Legend Key Visibility
$chartTable->setShowLegendKey(false);

Property Getters/Setters Summary
functiongetAutoScaleFont()
function
setAutoScaleFont(value)
           True if the text in the object changes font size when the object size changes. The default value is True.
functiongetBackgroundMode()
function
setBackgroundMode(value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
functiongetBorder()
Returns a Border object that represents the border of the object
functiongetFont()
Gets a Font object which represents the font setting of the specified chart data table.
functionhasBorderHorizontal()
function
setHasBorderHorizontal(value)
           True if the chart data table has horizontal cell borders
functionhasBorderOutline()
function
setHasBorderOutline(value)
           True if the chart data table has outline borders
functionhasBorderVertical()
function
setHasBorderVertical(value)
           True if the chart data table has vertical cell borders
functionhasHorizontalBorder()
function
setHasHorizontalBorder(value)
           True if the chart data table has horizontal cell borders
functionhasOutlineBorder()
function
setHasOutlineBorder(value)
           True if the chart data table has outline borders
functionhasVerticalBorder()
function
setHasVerticalBorder(value)
           True if the chart data table has vertical cell borders
functiongetShowLegendKey()
function
setShowLegendKey(value)
           True if the data label legend key is visible.
 

    • Property Getters/Setters Detail

      • getFont : Font 

        function getFont()
        Gets a Font object which represents the font setting of the specified chart data table.

      • getAutoScaleFont/setAutoScaleFont : boolean 

        function getAutoScaleFont() / function setAutoScaleFont(value)
        True if the text in the object changes font size when the object size changes. The default value is True.

      • getBackgroundMode/setBackgroundMode : Number 

        function getBackgroundMode() / function setBackgroundMode(value)
        Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.

      • hasBorderHorizontal/setHasBorderHorizontal : boolean 

        function hasBorderHorizontal() / function setHasBorderHorizontal(value)
        True if the chart data table has horizontal cell borders NOTE: This property is now obsolete. Instead, please use ChartDataTable.HasHorizontalBorder property. This property will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.

      • hasHorizontalBorder/setHasHorizontalBorder : boolean 

        function hasHorizontalBorder() / function setHasHorizontalBorder(value)
        True if the chart data table has horizontal cell borders

      • hasBorderVertical/setHasBorderVertical : boolean 

        function hasBorderVertical() / function setHasBorderVertical(value)
        True if the chart data table has vertical cell borders NOTE: This property is now obsolete. Instead, please use ChartDataTable.HasVerticalBorder property. This property will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.

      • hasVerticalBorder/setHasVerticalBorder : boolean 

        function hasVerticalBorder() / function setHasVerticalBorder(value)
        True if the chart data table has vertical cell borders

      • hasBorderOutline/setHasBorderOutline : boolean 

        function hasBorderOutline() / function setHasBorderOutline(value)
        True if the chart data table has outline borders NOTE: This property is now obsolete. Instead, please use ChartDataTable.HasOutlineBorder property. This property will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.

      • hasOutlineBorder/setHasOutlineBorder : boolean 

        function hasOutlineBorder() / function setHasOutlineBorder(value)
        True if the chart data table has outline borders

      • getShowLegendKey/setShowLegendKey : boolean 

        function getShowLegendKey() / function setShowLegendKey(value)
        True if the data label legend key is visible.

      • getBorder : Line 

        function getBorder()
        Returns a Border object that represents the border of the object