程序包 gu.sql2java.excel.annotations

注释接口 ExcelSheet

@Retention(RUNTIME) @Target({METHOD,TYPE}) @Repeatable(ExcelSheets.class) public @interface ExcelSheet
定义导出Excel 表数据的全局配置注解
作者:
guyadong

  • 元素详细资料

    • sheetName

      String sheetName
      excel Sheet名字
      默认值:
      "exportedExcel"

    • fileNamePrefix

      String fileNamePrefix
      导出的文件名前缀
      默认值:
      ""

    • title

      String title
      excel Sheet 标题
      默认值:
      ""

    • titleFontName

      String titleFontName
      标题字体名
      默认值:
      "Calibri"

    • titleFontHeight

      short titleFontHeight
      标题字体高度
      默认值:
      32

    • titleFontColor

      String titleFontColor
      标题字体颜色,参见 IndexedColors
      默认值:
      "BLACK"

    • titleFillColor

      String titleFillColor
      标题单元背景填充颜色,参见 IndexedColors
      默认值:
      "WHITE"

    • titleHorizontalAlign

      String titleHorizontalAlign
      标题对齐水平方式
      默认值:
      "CENTER"

    • headerFontName

      String headerFontName
      首行(字段名)字体名
      默认值:
      "Calibri"

    • headerFontHeight

      short headerFontHeight
      首行(字段名)字体高度
      默认值:
      16

    • headerFontColor

      String headerFontColor
      首行(字段名)字体颜色,参见 IndexedColors
      默认值:
      "BLACK"

    • headerFillColor

      String headerFillColor
      首行(字段名)单元背景填充颜色,参见 IndexedColors
      默认值:
      "GREY_25_PERCENT"

    • headerHorizontalAlign

      String headerHorizontalAlign
      首行(字段名)水平对齐方式
      默认值:
      "CENTER"

    • firstBold

      boolean firstBold
      字体设置:标题行字体加粗
      默认值:
      true

    • fontHeight

      short fontHeight
      默认字体高度
      默认值:
      16

    • fontName

      String fontName
      默认字体名
      默认值:
      "Calibri"

    • fontColor

      String fontColor
      默认字体颜色,参见 IndexedColors
      默认值:
      "BLACK"

    • fillColor

      String fillColor
      默认单元背景填充颜色,参见 IndexedColors
      默认值:
      "WHITE"

    • horizontalAlign

      String horizontalAlign
      默认导出字段水平对齐方式
      默认值:
      "CENTER"

    • integralFormat

      String integralFormat
      默认整数(Integer,Long,Short)格式
      默认值:
      "0"

    • dateTimeFormat

      String dateTimeFormat
      (Date)日期时间格式, 如: yyyy-MM-dd HH:mm:ss
      默认值:
      "yyyy-MM-dd HH:mm:ss"

    • dateFormat

      String dateFormat
      (Date)日期格式, 如: yyyy-MM-dd
      默认值:
      "yyyy-MM-dd"

    • timeFormat

      String timeFormat
      (Time)时间格式, 如: HH:mm:ss
      默认值:
      "HH:mm:ss"

    • timestampFormat

      String timestampFormat
      (Timestamp)时间戳格式, 如: yyyy-MM-dd HH:mm:ss
      默认值:
      "yyyy-MM-dd\'T\'HH:mm:ss.SSSZ"

    • scale

      int scale
      BigDecimal 精度 默认:-1(默认不开启BigDecimal格式化)
      默认值:
      -1

    • roundingMode

      int roundingMode
      BigDecimal 舍入规则 默认:BigDecimal.ROUND_HALF_EVEN
      默认值:
      6

    • maxHeight

      int maxHeight
      导出时在excel中每个列的最大高度, 单位为字符
      默认值:
      0

    • maxWidth

      int maxWidth
      导出时在excel中每个列的最大宽度, 单位为字符
      默认值:
      32

    • defaultValue

      String defaultValue
      当值为空时,字段的默认值
      默认值:
      ""

    • includeColumns

      String[] includeColumns
      字段输出白名单,在此名单中的字段会被输出,同时指定白名单和黑名单时以白名单为准
      默认值:
      {}

    • excludeColumns

      String[] excludeColumns
      字段输出黑名单,在此名单中的字段不会被输出,同时指定白名单和黑名单时以白名单为准
      默认值:
      {}

    • hideColumns

      String[] hideColumns
      隐藏字段名单,指定任何情况下都不输出的字段列表 在此名单中的字段,不论includeColumns()excludeColumns()如何设置都不会被输出
      默认值:
      {}

    • defaultIncludeColumns

      String[] defaultIncludeColumns
      默认的字段输出白名单,此字段用于给前端提供默认的输出字段及顺序
      默认值:
      {}

    • dynamicExcelNames

      String[] dynamicExcelNames
      动态输出Excel中的字段名列表,此字段用于服务方法中保存的动态输出EXCEL字段名
      从以下版本开始:
      3.26.0
      默认值:
      {}

    • getParameterArgName

      String getParameterArgName
      Spring Controller 服务方法中获取excel导出参数的开关参数名, 不需要注入SheetConfig
      默认值:
      "getParameter"

    • exportFileNameArgName

      String exportFileNameArgName
      Spring Controller 服务方法中定义导出文件名的参数名, 不需要注入SheetConfig
      默认值:
      "exportFileName"

    • beanClass

      Class<?> beanClass
      Spring Controller 服务方法中定义导出记录列表的原始记录对象类型
      默认值:
      java.lang.Object.class

    • customImporterClass

      Class<? extends CustomBeanParser> customImporterClass
      自定义导入数据转换实现类，定义此字段将忽略所有ExcelColumn注解和beanClass()定义
      从以下版本开始:
      3.29.0
      默认值:
      gu.sql2java.excel.CustomBeanParser.class