[]
        
(Showing Draft Content)

IFloor

Interface IFloor


public interface IFloor
Represents the floor of a 3-D chart.

Use this interface to format the floor area of a 3-D chart and to control its thickness. The floor exposes an IChartFormat object for line and fill formatting and belongs to a parent IChart.


 IShape shape = worksheet.getShapes().addChart(ChartType.Column3D, 200, 50, 300, 300);
 worksheet.getRange("A1:D3").setValue(new Object[][] {
     {null, "S1", "S2", "S3"}, {"Item1", 10, 25, 15}, {"Item2", 20, 30, 18}
 });
 shape.getChart().getSeriesCollection().add(worksheet.getRange("A1:D3"), RowCol.Columns, true, true);
 IFloor floor = shape.getChart().getFloor();
 floor.setThickness(20);
 
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the chart format of the floor.
    Gets the parent IChart that contains this floor.
    int
    Gets the thickness of the floor.
    void
    setThickness(int value)
    Sets the thickness of the floor.
  • Method Details

    • getFormat

      IChartFormat getFormat()
      Gets the chart format of the floor.

      The returned IChartFormat object provides access to the floor's fill and line formatting for a 3-D chart.

      
       worksheet.getRange("A1:B3").setValue(new Object[][] {
           {"Name", "Value"},
           {"Test 1", 10},
           {"Test 2", 20}
       });
       IChart chart = worksheet.getShapes().addChart(ChartType.ColumnClustered3D, 20, 20, 360, 220).getChart();
       chart.setSourceData(worksheet.getRange("A1:B3"));
       IChartFormat format = chart.getFloor().getFormat();
       format.getFill().getColor().setRGB(Color.GetRed());
       
      Returns:
      The IChartFormat object that represents the floor formatting.
    • getParent

      IChart getParent()
      Gets the parent IChart that contains this floor.

      Use this method to access the chart that owns the floor of a 3-D chart.

      
       worksheet.getRange("A1:B3").setValue(new Object[][] {
           {"Name", "Value"},
           {"Test 1", 10},
           {"Test 2", 20}
       });
       IChart chart = worksheet.getShapes().addChart(ChartType.Column3D, 20, 20, 360, 220).getChart();
       chart.setSourceData(worksheet.getRange("A1:B3"));
       IFloor floor = chart.getFloor();
       IChart parentChart = floor.getParent();
       
      Returns:
      The parent IChart of this floor.
    • getThickness

      int getThickness()
      Gets the thickness of the floor.

      Use this method to read the current thickness setting of the floor in a 3-D chart.

      
       worksheet.getRange("A1:B3").setValue(new Object[][] {
           {"Name", "Value"},
           {"Test 1", 10},
           {"Test 2", 20}
       });
       IChart chart = worksheet.getShapes().addChart(ChartType.Column3D, 20, 20, 360, 220).getChart();
       chart.setSourceData(worksheet.getRange("A1:B3"));
       IFloor floor = chart.getFloor();
       floor.setThickness(120);
       int thickness = floor.getThickness();
       
      Returns:
      The thickness of the floor.
    • setThickness

      void setThickness(int value)
      Sets the thickness of the floor.

      Use this method to set the thickness of the floor in a 3-D chart.

      
       worksheet.getRange("A1:B3").setValue(new Object[][] {
           {"Name", "Value"},
           {"Test 1", 10},
           {"Test 2", 20}
       });
       IChart chart = worksheet.getShapes().addChart(ChartType.Column3D, 20, 20, 360, 220).getChart();
       chart.setSourceData(worksheet.getRange("A1:B3"));
       IFloor floor = chart.getFloor();
       floor.setThickness(120);
       
      Parameters:
      value - The thickness of the floor.