Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextShape

文本图形类

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

capture

capture: boolean

该图形是否可被选中

content

content: string

文本内容

fixed

fixed: boolean

该图形是否被固定

fontFamily

fontFamily: string

字体样式

fontSize

fontSize: number

字体大小

isActionStackItem

isActionStackItem: boolean = true

是否为操作栈的对象，默认为 false，作用在 joinBaseData 的 api 中读取该字段来判断是否插入 actionStack 中。 在 Shape 类中会覆盖为 true。 在 Behavior 中会覆盖为 false。

isBold

isBold: boolean

是否加粗，默认：false

isItalics

isItalics: boolean

是否斜体，默认：false

isLineThrough

isLineThrough: boolean

是否有删除线，默认：false

isUnderLine

isUnderLine: boolean

是否有下划线，默认：false

shapeName

shapeName: string = ...

图形名称，默认为空字符串

strokeStyle

strokeStyle: string

字体颜色

whiteBoard

whiteBoard: WhiteBoard

白板实例

Static shapeName

shapeName: string = ...

Accessors

animationProgress

  • get animationProgress(): number

  • 动画时钟进度，范围：0 ~ 1

    Returns number

board

  • get board(): undefined | Board

  • 当前图形所在的画板

    Returns undefined | Board

boardId

  • get boardId(): string

  • 所在的画板 id

    Returns string

clientId

  • get clientId(): string

  • 客户端 id

    Returns string

durationTime

  • get durationTime(): number

  • 持续时间

    Returns number

erased

  • get erased(): boolean

  • 该图形是否已被擦除

    Returns boolean

id

  • get id(): string

  • 标识 id

    Returns string

isSelf

  • get isSelf(): boolean

  • 是否为实例化白板的用户对象

    description

    当前对象和所在的白板实例其中一个的 userInfo.userId 为空字符串或 undefined 时返回 false

    Returns boolean

isSelfByOperationModel

  • get isSelfByOperationModel(): boolean

  • 根据操作模式返回是否为当前用户创建的对象

    description

    NORMAL 下，永远返回 true

    description

    SELF 下，根据 isSelf 的条件进行判断

    description

    其他情况下返回 true

    Returns boolean

userInfo

  • 用户信息

    Returns undefined | UserInfo

visible

  • get visible(): boolean

  • 该图形是否可见

    Returns boolean

zIndex

  • get zIndex(): number

  • 层叠数

    Returns number

Methods

clear

  • clear(): void

  • 当前对象被清空的 hook

    Returns void

deviationPoints

  • deviationPoints(diffX: number, diffY: number): void

draw

getBBox

  • getBBox(): undefined | BBox

  • 获取包围盒（世界坐标系）

    Returns undefined | BBox

getBaseData

getShapeColor

  • getShapeColor(): string

  • 获取该图形的颜色描述。 获取优先级：该图形的 strokeStyle 属性 > 白板实例教具的 strokeStyle。

    Returns string

getShapeSvg

  • getShapeSvg(): undefined | SVGElement

  • 获取当前图形的 svg

    Returns undefined | SVGElement

    图形的 svg

isIntersectBBox

  • 判断当前图形是否与一个范围的包围盒有相交，默认返回 false

    Parameters

    Returns boolean

isNearby

  • isNearby(point: WorldPoint, distance?: number): boolean

  • 判断点是否靠近该图形，默认返回 false

    Parameters

    • point: WorldPoint

      世界坐标点

    • Optional distance: number

      判断距离

    Returns boolean

isOverlapVisionBBox

  • isOverlapVisionBBox(visionBBox: BBox): boolean

  • 判断当前图形是否与传入的视角包围盒有重叠的地方，默认返回 true

    Parameters

    • visionBBox: BBox

      视角包围盒包围盒

    Returns boolean

    返回 true 表示有重叠

redo

  • redo(): void

  • 当前对象被重做的 hook

    Returns void

setAnimationProgress

  • setAnimationProgress(progress: number): void

  • 设置图形动画进度值

    Parameters

    • progress: number

      进度，范围 0 ~ 1，小于 0 或大于 1 时默认为 0 或 1

    Returns void

setDurationTime

  • setDurationTime(durationTime: number): TextShape

setErased

setPoints

setVisible

  • 设置是否可见

    Parameters

    • visible: boolean = true

      是否可见，默认：true

    Returns TextShape

undo

  • undo(): void

  • 当前对象被撤回的 hook

    Returns void

zoomSeatPoints