TextLayerOptions

TextLayer构造函数options参数。

interface TextLayerOptions {
    anchor?: StyleValue<TextAnchor>;
    collides?: boolean;
    color?: StyleValue<string>;
    data?: any;
    enablePicked?: boolean;
    fillOpacity?: StyleValue<number>;
    fontFamily?: StyleValue<string>;
    fontSize?: StyleValue<number>;
    fontWeight?: StyleValue<string | number>;
    idKey?: string;
    isFlat?: boolean;
    lineHeight?: number;
    margin?: [number, number];
    maxZoom?: number;
    minZoom?: number;
    mouseStyleChange?: boolean;
    offset?: StyleValue<[number, number]>;
    opacity?: number;
    padding?: [number, number];
    pickThrough?: boolean;
    pickTolerance?: number;
    referCenter?: Point;
    renderStage?: RenderStage;
    rotation?: StyleValue<number>;
    scale?: StyleValue<number>;
    strokeColor?: StyleValue<string>;
    strokeWeight?: StyleValue<number>;
    text?: StyleValue<string>;
    textAlign?: "center" | "left" | "right";
    textMaxWidth?: number;
    visible?: boolean;
    waitTime?: number;
    zIndex?: number;
}

属性

#anchor?: StyleValue<TextAnchor>

锚点，决定坐标点落在文字的哪个位置，默认值：'center'

#collides?: boolean

是否开启碰撞剔除（密集时自动隐藏互相压盖的文字）默认值：true

#color?: StyleValue<string>

文字颜色，css 字符串，默认值：'#333'

#data?: any

初始数据，同 TextLayer.setData 的入参

#enablePicked?: boolean

是否开启鼠标交互（命中光标 + 事件派发）默认值：false

#fillOpacity?: StyleValue<number>

透明度 [0,1]，与图层级 opacity 相乘，默认值：1

#fontFamily?: StyleValue<string>

字体，默认值：'微软雅黑'

#fontSize?: StyleValue<number>

字号（px）默认值：14

#fontWeight?: StyleValue<string | number>

字重，默认值：'normal'

#idKey?: string

取要素 id 的字段名，默认值：'id'

#isFlat?: boolean

true 贴地（大小随缩放变化）；false 屏幕固定像素大小，默认值：false

#lineHeight?: number

行高（px）默认值：20

#margin?: [number, number]

碰撞盒外扩 [x, y]，控制文字之间的最小间距，默认值：[0, 0]

#maxZoom?: number

最大显示缩放等级，默认值：21

#minZoom?: number

最小显示缩放等级，默认值：3

#mouseStyleChange?: boolean

命中后是否更换鼠标光标，默认值：true

#offset?: StyleValue<[number, number]>

像素偏移 [x, y]，默认值：[0, 0]

#opacity?: number

图层级透明度 [0,1]，与逐条 fillOpacity 相乘，默认值：1

#padding?: [number, number]

图集槽位内边距 [x, y]，默认值：[2, 2]

#pickThrough?: boolean

命中后是否继续向下层派发，默认值：false

#pickTolerance?: number

命中容差（css px）默认值：4

#referCenter?: Point

图层参考中心点，规避大坐标浮点抖动

#renderStage?: RenderStage

绘制阶段，取值见 RenderStage

#rotation?: StyleValue<number>

旋转角度（度）默认值：0

#scale?: StyleValue<number>

缩放比例，默认值：1

#strokeColor?: StyleValue<string>

描边色，css 字符串，默认值：'rgba(255, 255, 255, 1)'

#strokeWeight?: StyleValue<number>

描边宽度（px），0 表示不描边，默认值：0

#text?: StyleValue<string>

文案，不设则读要素的 properties.text

#textAlign?: "center" | "left" | "right"

多行时的对齐方式，默认值：'center'

#textMaxWidth?: number

超过该宽度（px）换行，0 表示不换行，默认值：0

#visible?: boolean

是否显示，默认值：true

#waitTime?: number

碰撞剔除的节流间隔（ms）默认值：200

#zIndex?: number

显示层级，小的先画，默认值：1