asposecells.api

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

Property Getters/Setters Summary
methodgetBackgroundColor()
method
           Gets or sets the background com.aspose.cells.Color of the Area.
methodgetBorder()
method
setBorder(value)
           Gets or sets the border Line.
methodgetCenterX()
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.
methodgetCenterXPx()
Gets the x coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
methodgetCenterY()
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.
methodgetCenterYPx()
Gets the y coordinate of the left-bottom corner of Wall center in units of pixels after calls Chart.Calculate() method.
methodgetDepth()
Gets the depth front to back in units of 1/4000 of chart's width after calls Chart.Calculate() method.
methodgetDepthPx()
Gets the depth front to back in units of pixels after calls Chart.Calculate() method.
methodgetFillFormat()
Represents a FillFormat object that contains fill formatting properties for the specified chart or shape.
methodgetForegroundColor()
method
           Gets or sets the foreground com.aspose.cells.Color.
methodgetFormatting()
method
           Represents the formatting of the area. The value of the property is FormattingType integer constant.
methodgetHeight()
Gets the height of top to bottom in units of 1/4000 of chart's height after calls Chart.Calculate() method.
methodgetHeightPx()
Gets the height of top to bottom in units of pixels after calls Chart.Calculate() method.
methodgetInvertIfNegative()
method
           If the property is true and the value of chart point is a negative number, the foreground color and background color will be exchanged.
methodgetTransparency()
method
           Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
methodgetWidth()
Gets the width of left to right in units of 1/4000 of chart's width after calls Chart.Calculate() method.
methodgetWidthPx()
Gets the width of left to right in units of pixels after calls Chart.Calculate() method.
 
Method Summary
methodgetCubePointCount()
Gets the number of cube points after calls Chart.Calculate() method.
methodgetCubePointXPx(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
methodgetCubePointYPx(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 : int 

        int 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 : int 

        int 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 : int 

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

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

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

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

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

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

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

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

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

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

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

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

        boolean getInvertIfNegative() / 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 = Workbook()
        # Adding a new worksheet to the Workbook object
        sheetIndex = workbook.getWorksheets().add()
        # Obtaining the reference of the newly added worksheet by passing its sheet index
        worksheet = workbook.getWorksheets().get(sheetIndex)
        # 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 chart to the worksheet
        chartIndex = worksheet.getCharts().add(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(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(Color.getYellow())
        # Saving the Excel file
        workbook.save("Book1.xls")
      • getFillFormat : FillFormat 

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

        float getTransparency() / 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

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

        float 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

        float 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.