JSAPI Three API Reference
    正在准备搜索索引...

    类 Text

    文字网格对象，用于在地图上绘制文字标注。支持自定义字体样式、填充颜色、描边等特性。

    // 创建一个基础文字网格
    const text = engine.add(new mapvthree.Text({
        fontSize: 16,
        fontFamily: 'Arial',
        fillStyle: '#ff0000',
        strokeStyle: '#ffffff',
        lineWidth: 2,
        padding: [4, 4],
        keepSize: true
    }));

    // 设置数据源
    const data = mapvthree.GeoJSONDataSource.fromGeoJSON([{
        type: 'Feature',
        geometry: {
            type: 'Point',
            coordinates: [116.404, 39.915]
        },
        properties: {
            text: '北京市'
        }
    }]);

    // 定义text属性映射
    data.defineAttribute('text', 'text');
    text.dataSource = data;

    层级

    • GeoMesh
      • Text
    索引

    构造函数

    constructor

    属性

    isEventEntitySupported isGeoObject isMesh

    方法

    addAttributeRename clearAttributeRename dispose removeAttributeRename

    访问器

    dataSource fillStyle fontFamily fontSize lineWidth needsUpdate padding strokeStyle

    构造函数

    • 构造函数

      参数

      • parameters: {
            fillStyle?: string;
            fontFamily?: string;
            fontSize?: number;
            lineWidth?: number;
            padding?: number[];
            strokeStyle?: string;
        }

        传入参数对象

        • 可选fillStyle?: string

          绘制字的填充颜色

        • 可选fontFamily?: string

          字体，默认微软雅黑

        • 可选fontSize?: number

          字号大小，默认16

        • 可选lineWidth?: number

          绘制字的描边宽度

        • 可选padding?: number[]

          绘制字方块的内边距，默认[2, 2]

        • 可选strokeStyle?: string

          绘制字的描边颜色

      返回 Text

    属性

    isEventEntitySupported: true
    isGeoObject: true

    类型为GeoObject的标识

    isMesh: true

    类型为Mesh的标识

    方法

    • 添加属性重命名

      参数

      • key: string

        原始属性名，该组件的属性名

      • value: string

        重命名后的属性名，数据源的属性名

      返回 void

    • 清空属性重命名

      返回 void

    • 销毁object上的geometry和material实例，释放资源, 调用engine.remove(object)会自动销毁资源，不需要手动调用

      返回 void

    • 移除属性重命名

      参数

      • key: string

        原始属性名

      返回 void

    访问器

    • get dataSource(): DataSource

      object连接的数据源[[DataSource]]类

      返回 DataSource

    • set dataSource(dataSource: DataSource): void

      设置object的数据源

      参数

      • dataSource: DataSource

        数据源

      返回 void

    • get fillStyle(): string

      获取绘制字的填充颜色

      返回 string

      填充颜色

    • set fillStyle(value: string): void

      绘制字的填充颜色

      参数

      • value: string

        填充颜色

      返回 void

      text.fillStyle = '#ff0000';
    • get fontFamily(): string

      获取字体

      返回 string

      字体

    • set fontFamily(value: string): void

      字体设置

      参数

      • value: string

        字体

      返回 void

      text.fontFamily = 'Arial';
    • get fontSize(): number

      获取字号大小

      返回 number

      字号

    • set fontSize(value: number): void

      字号大小

      参数

      • value: number

        字号

      返回 void

      text.fontSize = 16;
    • get lineWidth(): number

      获取绘制字的描边粗细

      返回 number

      描边粗细

    • set lineWidth(value: number): void

      绘制字的描边粗细

      参数

      • value: number

        描边粗细

      返回 void

      text.lineWidth = 2;
    • get needsUpdate(): boolean

      是否需要更新

      返回 boolean

    • set needsUpdate(value: boolean): void

      设置object是否在下一帧更新

      参数

      • value: boolean

        设置为true，则下一帧渲染前更新该object

      返回 void

    • get padding(): number[]

      获取绘制字方块的内边距

      返回 number[]

      x轴与y轴的边距

    • set padding(value: number[]): void

      绘制字方块的内边距

      参数

      • value: number[]

        x轴与y轴的边距

      返回 void

      text.padding = [4, 4];
    • set strokeStyle(value: string): void

      绘制字的描边颜色

      参数

      • value: string

        描边颜色

      返回 void

      text.strokeStyle = '#ffffff';

    显示设置

    成员可见性

    目录

    构造函数
    属性
    方法
    访问器