kd.bos.form.chart

## 类 Label

- java.lang.Object
- - kd.bos.form.chart.Label

- 所有已实现的接口:
    java.io.Serializable

      public class Label
      extends java.lang.Object
      implements java.io.Serializable

  另请参阅:
    序列化表格

- - ### 构造器概要

    构造器
    构造器和说明
    `Label()`

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `java.lang.String` | `getAlign()` 文字水平对齐方式，默认自动。
    `java.lang.String` | `getBackgroundColor()` 文字块背景色。
    `java.lang.String` | `getBorderColor()` 文字块边框颜色。
    `java.lang.String` | `getBorderRadius()` 文字块的圆角。
    `java.lang.String` | `getBorderWidth()` 文字块边框宽度。
    `java.lang.String` | `getColor()` 文字的颜色。
    `java.lang.String` | `getDistance()` 距离图形元素的距离。
    `java.lang.String` | `getFontFamily()` 文字的字体系列 还可以是 'serif' , 'monospace', 'Arial', 'Courier New', 'Microsoft YaHei', ...
    `java.lang.String` | `getFontSize()` 文字的字体大小
    `java.lang.String` | `getFontStyle()` 文字字体的风格 可选： 'normal' 'italic' 'oblique'
    `java.lang.String` | `getFontWeight()` 文字字体的粗细 可选： 'normal' 'bold' 'bolder' 'lighter' 100 | 200 | 300 | 400...
    `java.lang.String` | `getFormatter()` 标签内容格式器，支持字符串模板和回调函数两种形式，字符串模板与回调函数返回的字符串均支持用 \n 换行。
    `java.lang.String` | `getHeight()` 文字块的高度。
    `java.lang.String` | `getLineHeight()` 行高。
    `java.util.List<java.lang.String>` | `getOffset()` 是否对文字进行偏移。
    `java.lang.String[]` | `getPadding()` 文字块的内边距。
    `Position` | `getPosition()` 标签的位置。
    `java.lang.String` | `getRotate()` 标签旋转。
    `java.lang.String` | `getShadowBlur()` 文字块的背景阴影长度。
    `java.lang.String` | `getShadowColor()` 文字块的背景阴影颜色。
    `java.lang.String` | `getShadowOffsetX()` 文字块的背景阴影 X 偏移。
    `java.lang.String` | `getShadowOffsetY()` 文字块的背景阴影 Y 偏移。
    `java.lang.String` | `getTextBorderColor()` 文字本身的描边颜色。
    `java.lang.String` | `getTextBorderWidth()` 文字本身的描边宽度。
    `java.lang.String` | `getTextShadowBlur()` 文字本身的阴影颜色。
    `java.lang.String` | `getTextShadowColor()` 文字本身的阴影颜色。
    `java.lang.String` | `getTextShadowOffsetX()` 文字本身的阴影 X 偏移。
    `java.lang.String` | `getTextShadowOffsetY()` 文字本身的阴影 Y 偏移。
    `java.lang.String` | `getVerticalAlign()` 文字垂直对齐方式，默认自动。
    `java.lang.String` | `getWidth()` 文字块的宽度。
    `boolean` | `isShow()` 是否显示标签。
    `void` | `setAlign(java.lang.String align)`
    `void` | `setBackgroundColor(java.lang.String backgroundColor)`
    `void` | `setBorderColor(java.lang.String borderColor)`
    `void` | `setBorderRadius(java.lang.String borderRadius)`
    `void` | `setBorderWidth(java.lang.String borderWidth)`
    `void` | `setColor(java.lang.String color)`
    `void` | `setDistance(java.lang.String distance)`
    `void` | `setFontFamily(java.lang.String fontFamily)`
    `void` | `setFontSize(java.lang.String fontSize)`
    `void` | `setFontStyle(java.lang.String fontStyle)`
    `void` | `setFontWeight(java.lang.String fontWeight)`
    `void` | `setFormatter(java.lang.String formatter)`
    `void` | `setHeight(java.lang.String height)`
    `void` | `setLineHeight(java.lang.String lineHeight)`
    `void` | `setOffset(java.util.List<java.lang.String> offset)`
    `void` | `setPadding(java.lang.String[] padding)`
    `void` | `setPosition(Position position)`
    `void` | `setRotate(java.lang.String rotate)`
    `void` | `setShadowBlur(java.lang.String shadowBlur)` 文字块的背景阴影长度。
    `void` | `setShadowColor(java.lang.String shadowColor)`
    `void` | `setShadowOffsetX(java.lang.String shadowOffsetX)`
    `void` | `setShadowOffsetY(java.lang.String shadowOffsetY)`
    `void` | `setShow(boolean show)`
    `void` | `setTextBorderColor(java.lang.String textBorderColor)`
    `void` | `setTextBorderWidth(java.lang.String textBorderWidth)`
    `void` | `setTextShadowBlur(java.lang.String textShadowBlur)`
    `void` | `setTextShadowColor(java.lang.String textShadowColor)`
    `void` | `setTextShadowOffsetX(java.lang.String textShadowOffsetX)`
    `void` | `setTextShadowOffsetY(java.lang.String textShadowOffsetY)`
    `void` | `setVerticalAlign(java.lang.String verticalAlign)`
    `void` | `setWidth(java.lang.String width)`

    - ### 从类继承的方法 java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### Label

          public Label()

  - ### 方法详细资料

    - #### isShow

          public boolean isShow()

      是否显示标签。
      返回:

    - #### setShow

          public void setShow(boolean show)

    - #### getPosition

          public Position getPosition()

      标签的位置。
      返回:

    - #### setPosition

          public void setPosition(Position position)

    - #### getDistance

          public java.lang.String getDistance()

      距离图形元素的距离。当 position 为字符描述值（如 'top'、'insideRight'）时候有效。
      返回:

    - #### setDistance

          public void setDistance(java.lang.String distance)

    - #### getRotate

          public java.lang.String getRotate()

      标签旋转。从 -90 度到 90 度。正值是逆时针。
      返回:

    - #### setRotate

          public void setRotate(java.lang.String rotate)

    - #### getOffset

          public java.util.List<java.lang.String> getOffset()

      是否对文字进行偏移。默认不偏移。例如：[30, 40] 表示文字在横向上偏移 30，纵向上偏移 40。
      返回:

    - #### setOffset

          public void setOffset(java.util.List<java.lang.String> offset)

    - #### getFormatter

          public java.lang.String getFormatter()

      标签内容格式器，支持字符串模板和回调函数两种形式，字符串模板与回调函数返回的字符串均支持用 \n 换行。 字符串模板 模板变量有： {a}：系列名。 {b}：数据名。 {c}：数据值。 ：数据中名为'xxx'的维度的值，如 表示名为'product'` 的维度的值。 ：数据中维度n的值，如` 表示维度 3 的值，从 0 开始计数。 示例： formatter: '{b}: '
      返回:

    - #### setFormatter

          public void setFormatter(java.lang.String formatter)

    - #### getColor

          public java.lang.String getColor()

      文字的颜色。 如果设置为 'auto'，则为视觉映射得到的颜色，如系列色。
      返回:

    - #### setColor

          public void setColor(java.lang.String color)

    - #### getFontStyle

          public java.lang.String getFontStyle()

      文字字体的风格 可选： 'normal' 'italic' 'oblique'
      返回:

    - #### setFontStyle

          public void setFontStyle(java.lang.String fontStyle)

    - #### getFontWeight

          public java.lang.String getFontWeight()

      文字字体的粗细 可选： 'normal' 'bold' 'bolder' 'lighter' 100 | 200 | 300 | 400...
      返回:

    - #### setFontWeight

          public void setFontWeight(java.lang.String fontWeight)

    - #### getFontFamily

          public java.lang.String getFontFamily()

      文字的字体系列 还可以是 'serif' , 'monospace', 'Arial', 'Courier New', 'Microsoft YaHei', ...
      返回:

    - #### setFontFamily

          public void setFontFamily(java.lang.String fontFamily)

    - #### getFontSize

          public java.lang.String getFontSize()

      文字的字体大小
      返回:

    - #### setFontSize

          public void setFontSize(java.lang.String fontSize)

    - #### getAlign

          public java.lang.String getAlign()

      文字水平对齐方式，默认自动。 可选： 'left' 'center' 'right' rich 中如果没有设置 align，则会取父层级的 align。例如： { align: right, rich: { a: { // 没有设置 `align`，则 `align` 为 right } } }
      返回:

    - #### setAlign

          public void setAlign(java.lang.String align)

    - #### getVerticalAlign

          public java.lang.String getVerticalAlign()

      文字垂直对齐方式，默认自动。 可选： 'top' 'middle' 'bottom' rich 中如果没有设置 verticalAlign，则会取父层级的 verticalAlign。例如： { verticalAlign: bottom, rich: { a: { // 没有设置 `verticalAlign`，则 `verticalAlign` 为 bottom } } }
      返回:

    - #### setVerticalAlign

          public void setVerticalAlign(java.lang.String verticalAlign)

    - #### getLineHeight

          public java.lang.String getLineHeight()

      行高。 rich 中如果没有设置 lineHeight，则会取父层级的 lineHeight。例如： { lineHeight: 56, rich: { a: { // 没有设置 `lineHeight`，则 `lineHeight` 为 56 } } }
      返回:

    - #### setLineHeight

          public void setLineHeight(java.lang.String lineHeight)

    - #### getBackgroundColor

          public java.lang.String getBackgroundColor()

      文字块背景色。 可以是直接的颜色值，例如：'#123234', 'red', rgba(0,23,11,0.3)'。 可以支持使用图片，例如： backgroundColor: { image: 'xxx/xxx.png' // 这里可以是图片的 URL， // 或者图片的 dataURI， // 或者 HTMLImageElement 对象， // 或者 HTMLCanvasElement 对象。 } 当使用图片的时候，可以使用 width 或 height 指定高宽，也可以不指定自适应。 如果设置为 'auto'，则为视觉映射得到的颜色，如系列色。
      返回:

    - #### setBackgroundColor

          public void setBackgroundColor(java.lang.String backgroundColor)

    - #### getBorderColor

          public java.lang.String getBorderColor()

      文字块边框颜色。 如果设置为 'auto'，则为视觉映射得到的颜色，如系列色。
      返回:

    - #### setBorderColor

          public void setBorderColor(java.lang.String borderColor)

    - #### getBorderWidth

          public java.lang.String getBorderWidth()

      文字块边框宽度。
      返回:

    - #### setBorderWidth

          public void setBorderWidth(java.lang.String borderWidth)

    - #### getBorderRadius

          public java.lang.String getBorderRadius()

      文字块的圆角。
      返回:

    - #### setBorderRadius

          public void setBorderRadius(java.lang.String borderRadius)

    - #### getPadding

          public java.lang.String[] getPadding()

      文字块的内边距。例如： padding: [3, 4, 5, 6]：表示 [上, 右, 下, 左] 的边距。 padding: 4：表示 padding: [4, 4, 4, 4]。 padding: [3, 4]：表示 padding: [3, 4, 3, 4]。
      返回:

    - #### setPadding

          public void setPadding(java.lang.String[] padding)

    - #### getShadowColor

          public java.lang.String getShadowColor()

      文字块的背景阴影颜色。
      返回:

    - #### setShadowColor

          public void setShadowColor(java.lang.String shadowColor)

    - #### getShadowBlur

          public java.lang.String getShadowBlur()

      文字块的背景阴影长度。
      返回:

    - #### setShadowBlur

          public void setShadowBlur(java.lang.String shadowBlur)

      文字块的背景阴影长度。
      参数:
        `shadowBlur` -

    - #### getShadowOffsetX

          public java.lang.String getShadowOffsetX()

      文字块的背景阴影 X 偏移。
      返回:

    - #### setShadowOffsetX

          public void setShadowOffsetX(java.lang.String shadowOffsetX)

    - #### getShadowOffsetY

          public java.lang.String getShadowOffsetY()

      文字块的背景阴影 Y 偏移。
      返回:

    - #### setShadowOffsetY

          public void setShadowOffsetY(java.lang.String shadowOffsetY)

    - #### getWidth

          public java.lang.String getWidth()

      文字块的宽度。一般不用指定，不指定则自动是文字的宽度。在想做表格项或者使用图片（参见 backgroundColor）时，可能会使用它。
      返回:

    - #### setWidth

          public void setWidth(java.lang.String width)

    - #### getHeight

          public java.lang.String getHeight()

      文字块的高度。一般不用指定，不指定则自动是文字的高度。
      返回:

    - #### setHeight

          public void setHeight(java.lang.String height)

    - #### getTextBorderColor

          public java.lang.String getTextBorderColor()

      文字本身的描边颜色。
      返回:

    - #### setTextBorderColor

          public void setTextBorderColor(java.lang.String textBorderColor)

    - #### getTextBorderWidth

          public java.lang.String getTextBorderWidth()

      文字本身的描边宽度。
      返回:

    - #### setTextBorderWidth

          public void setTextBorderWidth(java.lang.String textBorderWidth)

    - #### getTextShadowColor

          public java.lang.String getTextShadowColor()

      文字本身的阴影颜色。
      返回:

    - #### setTextShadowColor

          public void setTextShadowColor(java.lang.String textShadowColor)

    - #### getTextShadowBlur

          public java.lang.String getTextShadowBlur()

      文字本身的阴影颜色。
      返回:

    - #### setTextShadowBlur

          public void setTextShadowBlur(java.lang.String textShadowBlur)

    - #### getTextShadowOffsetX

          public java.lang.String getTextShadowOffsetX()

      文字本身的阴影 X 偏移。
      返回:

    - #### setTextShadowOffsetX

          public void setTextShadowOffsetX(java.lang.String textShadowOffsetX)

    - #### getTextShadowOffsetY

          public java.lang.String getTextShadowOffsetY()

      文字本身的阴影 Y 偏移。
      返回:

    - #### setTextShadowOffsetY

          public void setTextShadowOffsetY(java.lang.String textShadowOffsetY)