Options
All
  • Public
  • Public/Protected
  • All
Menu
collboard-modules-sdk

Hierarchy

Index

Constructors

  • new TextArt(content: string, color: string, fontSize: number, bold: boolean, italic: boolean, underline: boolean, listStyle: IListStyle): TextArt
  • Parameters

    • content: string
    • color: string
    • fontSize: number
    • bold: boolean
    • italic: boolean
    • underline: boolean
    • listStyle: IListStyle

    Returns TextArt

Properties

__size: any
artId: uuid

Unique identifier of each art

bold: boolean
color: string
content: string
defaultZIndex: number

Default z-index of art

Needs to be between 1-9 (including), otherwise it can lead to undefined behavior.

When locked, decreases by one.

Note: This will be replaced with proper object ordering in the near future, however it is highly suggested to override use property until then.

fontSize: number
italic: boolean
listStyle: IListStyle
locked: boolean

Marks, whether art is locked

TODO: [✨] Maybe add is prefix

opacity?: number

Opacity of an art

Value is automatically used by ArtShell when rendering

Note: only works on 2D arts

rotation: number

Object rotation

deprecated

Make it using BoundingBox

shift: IVectorData

Translation vector of art

deprecated

use transform property instead

underline: boolean
manifest: { deprecatedNames: string; name: string }

Type declaration

  • deprecatedNames: string
  • name: string
serializeName: string

Accessors

  • get acceptedAttributes(): string[]
  • Returns string[]

  • get bottomLeft(): IVectorData
  • Position of bottom left corner of art (absolute including shift)

    Value is used mostly when making selection

    deprecated

    Make it using BoundingBox

    Returns IVectorData

  • get bottomRight(): Vector
  • Returns Vector

  • set point1(point1: IVectorData): void
  • get size(): Vector
  • Returns Vector

  • get topLeft(): IVectorData
  • Returns IVectorData

  • get topRight(): IVectorData
  • Position of top right corner of art (absolute including shift)

    Value is used mostly when making selection

    deprecated

    Make it using BoundingBox

    Returns IVectorData

  • get transform(): Transform
  • set transform(transformData: ITransformData): void
  • Get the transform which is created from a deprecated shift

    Returns Transform

  • Set the transform which is converted and saved as a deprecated shift

    Parameters

    • transformData: ITransformData

    Returns void

Methods

  • isNear(pointToTest: IVectorData): boolean
  • Function determining, whether a point is near the art

    Default implementation uses square bounding box

    Parameters

    • pointToTest: IVectorData

    Returns boolean

  • Move art to by vector (= relative)

    deprecated

    use transform property instead

    Parameters

    • shift: IVectorData

    Returns TextArt

  • render(isSelected: boolean, systems: ISystems): Promise<Element>
  • Function called when object needs to be rendered on screen

    Parameters

    Returns Promise<Element>

  • setShift(shift: IVectorData): TextArt
  • Move art to certain vector (= absolute)

    deprecated

    use transform property instead

    Parameters

    • shift: IVectorData

    Returns TextArt