Package com.grapecity.documents.excel

Interface ISlicer

public interface ISlicer
Represents a slicer in a IWorkbook.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
    Deletes the slicer and removes it from the associated ISlicerscollection.
    void
    fromJson(String json)
    Updates the slicer settings from the json string.
    String
    getCaption()
    Gets the caption of the specified slicer.
    boolean
    getDisplayHeader()
    Gets whether the header that displays the slicer's caption is visible.
    double
    getHeight()
    Gets the height of the specified slicer, in points.
    double
    getLeft()
    Gets the horizontal position of the specified slicer, in points, relative to the upper-left corner of cell A1 on a worksheet.
    String
    getName()
    Gets the name of the specified slicer.
    int
    getNumberOfColumns()
    Gets the number of columns in the specified slicer.
    double
    getRowHeight()
    Gets the height, in points, of each row in the specified slicer.
    IShape
    getShape()
    Gets the IShape object associated with the specified slicer.
    ISlicerCache
    getSlicerCache()
    Gets the ISlicerCache object associated with the slicer.
    ITableStyle
    getStyle()
    Gets the style currently applied to the specified slicer.
    double
    getTop()
    Gets the vertical position of the specified slicer, in points, relative to the upper-left corner of cell A1 on a worksheet.
    double
    getWidth()
    Gets the width of the specified slicer, in points.
    void
    setCaption(String value)
    Sets the caption of the specified slicer.
    void
    setDisplayHeader(boolean value)
    Sets whether the header that displays the slicer's caption is visible.
    void
    setHeight(double value)
    Sets the height of the specified slicer, in points.
    void
    setLeft(double value)
    Sets the horizontal position of the specified slicer, in points, relative to the upper-left corner of cell A1 on a worksheet.
    void
    setName(String value)
    Sets the name of the specified slicer.
    void
    setNumberOfColumns(int value)
    Sets the number of columns in the specified slicer.
    void
    setRowHeight(double value)
    Sets the height, in points, of each row in the specified slicer.
    void
    setStyle(ITableStyle value)
    Sets the style currently applied to the specified slicer.
    void
    setTop(double value)
    Sets the vertical position of the specified slicer, in points, relative to the upper-left corner of cell A1 on a worksheet.
    void
    setWidth(double value)
    Sets the width of the specified slicer, in points.
    String
    toJson()
    Generates a json string from slicer.

  • Method Details

    • getCaption

      String getCaption()
      Gets the caption of the specified slicer.

    • setCaption

      void setCaption(String value)
      Sets the caption of the specified slicer.

    • getDisplayHeader

      boolean getDisplayHeader()
      Gets whether the header that displays the slicer's caption is visible.

    • setDisplayHeader

      void setDisplayHeader(boolean value)
      Sets whether the header that displays the slicer's caption is visible.

    • getHeight

      double getHeight()
      Gets the height of the specified slicer, in points.

    • setHeight

      void setHeight(double value)
      Sets the height of the specified slicer, in points.

    • getLeft

      double getLeft()
      Gets the horizontal position of the specified slicer, in points, relative to the upper-left corner of cell A1 on a worksheet.

    • setLeft

      void setLeft(double value)
      Sets the horizontal position of the specified slicer, in points, relative to the upper-left corner of cell A1 on a worksheet.

    • getName

      String getName()
      Gets the name of the specified slicer.

    • setName

      void setName(String value)
      Sets the name of the specified slicer.

    • getNumberOfColumns

      int getNumberOfColumns()
      Gets the number of columns in the specified slicer.

    • setNumberOfColumns

      void setNumberOfColumns(int value)
      Sets the number of columns in the specified slicer.

    • getRowHeight

      double getRowHeight()
      Gets the height, in points, of each row in the specified slicer.

    • setRowHeight

      void setRowHeight(double value)
      Sets the height, in points, of each row in the specified slicer.

    • getSlicerCache

      ISlicerCache getSlicerCache()
      Gets the ISlicerCache object associated with the slicer.

    • getShape

      IShape getShape()
      Gets the IShape object associated with the specified slicer.

    • getTop

      double getTop()
      Gets the vertical position of the specified slicer, in points, relative to the upper-left corner of cell A1 on a worksheet.

    • setTop

      void setTop(double value)
      Sets the vertical position of the specified slicer, in points, relative to the upper-left corner of cell A1 on a worksheet.

    • getWidth

      double getWidth()
      Gets the width of the specified slicer, in points.

    • setWidth

      void setWidth(double value)
      Sets the width of the specified slicer, in points.

    • delete

      void delete()
      Deletes the slicer and removes it from the associated ISlicerscollection.

    • getStyle

      ITableStyle getStyle()
      Gets the style currently applied to the specified slicer.

    • setStyle

      void setStyle(ITableStyle value)
      Sets the style currently applied to the specified slicer.

    • fromJson

      void fromJson(String json)
      Updates the slicer settings from the json string.
      Parameters:
      json - the json string contains a slicer

    • toJson

      String toJson()
      Generates a json string from slicer.
      Returns:
      the json string contains a slicer