Class SceneCanvasBackgroundImageDto

Hierarchy

SceneCanvasBackgroundImageDto

Index

Constructors

constructor

Properties

Constructors

constructor

new SceneCanvasBackgroundImageDto(imageUrl?: string, repeat?: backgroundRepeatEnum, size?: backgroundSizeEnum, position?: gradientPositionEnum, attachment?: backgroundAttachmentEnum, origin?: backgroundOriginClipEnum, clip?: backgroundOriginClipEnum): SceneCanvasBackgroundImageDto

- Defined in bitbybit-docs.d.ts:15084
Parameters
- Optional imageUrl: string
- Optional repeat: backgroundRepeatEnum
- Optional size: backgroundSizeEnum
- Optional position: gradientPositionEnum
- Optional attachment: backgroundAttachmentEnum
- Optional origin: backgroundOriginClipEnum
- Optional clip: backgroundOriginClipEnum
Returns SceneCanvasBackgroundImageDto

Properties

attachment

attachment: backgroundAttachmentEnum

Background attachment

default: scroll

clip

clip: backgroundOriginClipEnum

Background clip

default: borderBox

Optional imageUrl

imageUrl: string

URL of the background image

default: undefined

origin

origin: backgroundOriginClipEnum

Background origin

default: paddingBox

position

position: gradientPositionEnum

Position of the background image (enum values or specific values like '50% 50%')

default: center

repeat

repeat: backgroundRepeatEnum

How the background image should repeat

default: noRepeat

size

size: backgroundSizeEnum

Size of the background image (enum values or specific values like '100px 50px')

default: cover

Generated using TypeDoc