Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BackgroundPatternArt

Art setting background with pattern style (scrolling)

collboard-modules-sdk

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BackgroundPatternArt(src: string, size: IVectorData, opacity?: number, z?: number): BackgroundPatternArt

  • Parameters

    • src: string

      Source of the background pattern tile

    • size: IVectorData

      Size of the background pattern tile

    • Optional opacity: number

      Opacity applied to background image

    • Optional z: number

      see AbstractBackgroundArt

    Returns BackgroundPatternArt

Properties

Readonly artId

artId: uuid

Unique identifier of each art

opacity

opacity: number

size

size: IVectorData

src

src: string

z

z: number

Static manifest

manifest: { deprecatedNames: string; name: string }

Type declaration

  • deprecatedNames: string
  • name: string

Static serializeName

serializeName: string

Methods

additionalStyle

  • additionalStyle(): CSSProperties

  • Getter with static CSS properties for the <div class="board-bg"> rendered within BoardComponent

    Returns CSSProperties

transformStyle

  • transformStyle(transform: Transform): CSSProperties

  • Getter with dynamic CSS properties for the <div class="board-bg"> rendered within BoardComponent

    Parameters

    • transform: Transform

    Returns CSSProperties