asposecells.api
Class Floor

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

Example:

# Instantiate the License class
license = License()

# Pass only the name of the license file embedded in the assembly
license.setLicense("Aspose.Cells.lic")

# Instantiate the workbook object
workbook = Workbook()

# Get cells collection
cells = workbook.getWorksheets().get(0).getCells()

# Put values in cells
cells.get("A1").putValue(1)

cells.get("A2").putValue(2)

cells.get("A3").putValue(3)

# get charts colletion
charts = workbook.getWorksheets().get(0).getCharts()

# add a new chart 
index = charts.add(ChartType.COLUMN_3_D_STACKED, 5, 0, 15, 5)

# get the newly added chart
chart = charts.get(index)

# set charts nseries
chart.getNSeries().add("A1:A3", True)

# Show data labels
chart.getNSeries().get(0).getDataLabels().setValueShown(True)

# Get chart's floor
floor = chart.getFloor()

# set floor's border as red
floor.getBorder().setColor(Color.getRed())

# set fill format
floor.getFillFormat().setPresetColorGradient(GradientPresetType.CALM_WATER, GradientStyleType.DIAGONAL_DOWN, 2)

# save the file
workbook.save("Book1.xls")

Property Getters/Setters Summary
methodgetBackgroundColor()
methodsetBackgroundColor(value)
           Gets or sets the background com.aspose.cells.Color of the Area.
methodgetBorder()
methodsetBorder(value)
           Gets or sets the border Line.
methodgetFillFormat()
           Represents a object that contains fill formatting properties for the specified chart or shape.
methodgetForegroundColor()
methodsetForegroundColor(value)
           Gets or sets the foreground com.aspose.cells.Color.
methodgetFormatting()
methodsetFormatting(value)
           Represents the formatting of the area. The value of the property is FormattingType integer constant.
methodgetInvertIfNegative()
methodsetInvertIfNegative(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.
methodgetTransparency()
methodsetTransparency(value)
           Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
 
Method Summary
methodisAuto()→ inherited from Area
          
methodisVisible()→ inherited from Area
          
methodsetAuto(isAuto)→ inherited from Area
          
 

Property Getters/Setters Detail

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 object that contains fill formatting properties for the specified chart or shape.
See Also:
FillFormat

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

isAuto

boolean isAuto()

isVisible

boolean isVisible()

setAuto

 setAuto(isAuto)

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.