aspose.cells

Class Walls

Encapsulates the object that represents the walls of a 3-D chart.

Property Getters/Setters Summary
functiongetBackgroundColor()
function
           Gets or sets the background com.aspose.cells.Color of the Area.
functiongetBorder()
function
setBorder(value)
           Gets or sets the border Line.
functiongetCenterX()
Gets the x coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart's width after calls Chart.Calculate() method.
functiongetCenterXPx()
Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
functiongetCenterY()
Gets the y coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart's height after calls Chart.Calculate() method.
functiongetCenterYPx()
Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
functiongetDepth()
Gets the depth front to back in units of 1/4000 of chart's width after calls Chart.Calculate() method.
functiongetDepthPx()
Gets the depth front to back in units of pixels after calls Chart.Calculate() method.
functiongetFillFormat()
Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
functiongetForegroundColor()
function
           Gets or sets the foreground com.aspose.cells.Color.
functiongetFormatting()
function
           Represents the formatting of the area. The value of the property is FormattingType integer constant.
functiongetHeight()
Gets the height of top to bottom in units of 1/4000 of chart's height after calls Chart.Calculate() method.
functiongetHeightPx()
Gets the height of top to bottom in units of pixels after calls Chart.Calculate() method.
functiongetInvertIfNegative()
function
           If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.
functiongetTransparency()
function
           Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
functiongetWidth()
Gets the width of left to right in units of 1/4000 of chart's width after calls Chart.Calculate() method.
functiongetWidthPx()
Gets the width of left to right in units of pixels after calls Chart.Calculate() method.
 
Method Summary
functiongetCubePointCount()
Gets the number of cube points after calls Chart.Calculate() method.
functiongetCubePointXPx(index)
Gets x-coordinate of the apex point of walls cube after calls Chart.Calculate() method. The number of apex points of walls cube is eight
functiongetCubePointYPx(index)
Gets y-coordinate of the apex point of walls cube after calls Chart.Calculate() method. The number of apex points of walls cube is eight.
 

    • Property Getters/Setters Detail

      • getCenterX : Number 

        function getCenterX()
        
        Gets the x coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart's width after calls Chart.Calculate() method.
      • getCenterY : Number 

        function getCenterY()
        
        Gets the y coordinate of the left-bottom corner of Wall center in units of 1/4000 of chart's height after calls Chart.Calculate() method.
      • getWidth : Number 

        function getWidth()
        
        Gets the width of left to right in units of 1/4000 of chart's width after calls Chart.Calculate() method.
      • getDepth : Number 

        function getDepth()
        
        Gets the depth front to back in units of 1/4000 of chart's width after calls Chart.Calculate() method.
      • getHeight : Number 

        function getHeight()
        
        Gets the height of top to bottom in units of 1/4000 of chart's height after calls Chart.Calculate() method.
      • getCenterXPx : Number 

        function getCenterXPx()
        
        Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
      • getCenterYPx : Number 

        function getCenterYPx()
        
        Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
      • getWidthPx : Number 

        function getWidthPx()
        
        Gets the width of left to right in units of pixels after calls Chart.Calculate() method.
      • getDepthPx : Number 

        function getDepthPx()
        
        Gets the depth front to back in units of pixels after calls Chart.Calculate() method.
      • getHeightPx : Number 

        function getHeightPx()
        
        Gets the height of top to bottom in units of pixels after calls Chart.Calculate() method.
      • getBorder/setBorder : Line 

        function getBorder() / function setBorder(value)
        
        Gets or sets the border Line.
      • getBackgroundColor/setBackgroundColor : Color 

        function getBackgroundColor() / function setBackgroundColor(value)
        
        Gets or sets the background com.aspose.cells.Color of the Area.
      • getForegroundColor/setForegroundColor : Color 

        function getForegroundColor() / function setForegroundColor(value)
        
        Gets or sets the foreground com.aspose.cells.Color.
      • getFormatting/setFormatting : Number 

        function getFormatting() / function setFormatting(value)
        
        Represents the formatting of the area. The value of the property is FormattingType integer constant.
      • getInvertIfNegative/setInvertIfNegative : boolean 

        function getInvertIfNegative() / function setInvertIfNegative(value)
        
        If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.

        Example:

        //Instantiating a Workbook object
        $workbook = new cells\Workbook();
        $worksheet = $workbook->getWorksheets()->get(0);
        $cells = $worksheet->getCells();
        $cells->get("A1")->putValue(50);
        $cells->get("A2")->putValue(-100);
        $cells->get("A3")->putValue(150);
        //Adding a chart to the worksheet
        $chartIndex = $worksheet->getCharts()->add(cells\ChartType::COLUMN, 5, 0, 15, 5);
        //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 "A3"
        $chart->getNSeries()->add("A1:A3", true);
        $chart->getNSeries()->get(0)->getArea()->setInvertIfNegative(true);
        //Setting the foreground color of the 1st NSeries area
        $chart->getNSeries()->get(0)->getArea()->setForegroundColor(cells\Color::getRed());
        //Setting the background color of the 1st NSeries area->
        //The displayed area color of second chart point will be the background color->
        $chart->getNSeries()->get(0)->getArea()->setBackgroundColor(cells\Color::getYellow());
      • getFillFormat : FillFormat 

        function getFillFormat()
        
        Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
      • getTransparency/setTransparency : Number 

        function getTransparency() / function setTransparency(value)
        
        Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
    • Method Detail

      • getCubePointCount

        function getCubePointCount()
        Gets the number of cube points after calls Chart.Calculate() method.
      • getCubePointXPx

        function getCubePointXPx(index)
        Gets x-coordinate of the apex point of walls cube after calls Chart.Calculate() method. The number of apex points of walls cube is eight
      • getCubePointYPx

        function getCubePointYPx(index)
        Gets y-coordinate of the apex point of walls cube after calls Chart.Calculate() method. The number of apex points of walls cube is eight.