Preview 2.0 is now in Public Beta!
Read the Announcement
Note: You are on the beta version of our docs. This is a work in progress and may contain broken links and pages.
Background

Summary

Constructors

constructor

Constructors

constructor

new Background(): Background
Returns Background

Properties

borderBottomColor

borderBottomLeftRadius

borderBottomLeftRadius: number

borderBottomRightRadius

borderBottomRightRadius: number

borderBottomWidth

borderLeftColor

borderLeftWidth

borderRightColor

borderRightWidth

borderTopLeftRadius

borderTopLeftRadius: number

borderTopRightRadius

borderTopRightRadius: number

borderTopWidth

boxShadow

clearFlags

image

image: string | LinearGradient

Methods

getBoxShadow

getBoxShadow(): CSSShadow

getUniformBorderColor

getUniformBorderColor(): Color

getUniformBorderRadius

getUniformBorderRadius(): number

getUniformBorderWidth

getUniformBorderWidth(): number

hasBorderColor

hasBorderColor(): boolean

hasBorderRadius

hasBorderRadius(): boolean

hasBorderWidth

hasBorderWidth(): boolean

hasBoxShadow

hasBoxShadow(): boolean

hasUniformBorder

hasUniformBorder(): boolean

hasUniformBorderColor

hasUniformBorderColor(): boolean

hasUniformBorderRadius

hasUniformBorderRadius(): boolean

hasUniformBorderWidth

hasUniformBorderWidth(): boolean

isEmpty

isEmpty(): boolean

toString

toString(): string

withBorderBottomColor

withBorderBottomColor(value: Color): Background
Parameter Default Description
value

Returns Background

withBorderBottomLeftRadius

withBorderBottomLeftRadius(value: number): Background
Parameter Default Description
value
number

Returns Background

withBorderBottomRightRadius

withBorderBottomRightRadius(value: number): Background
Parameter Default Description
value
number

Returns Background

withBorderBottomWidth

withBorderBottomWidth(value: number): Background
Parameter Default Description
value
number

Returns Background

withBorderLeftColor

withBorderLeftColor(value: Color): Background
Parameter Default Description
value

Returns Background

withBorderLeftWidth

withBorderLeftWidth(value: number): Background
Parameter Default Description
value
number

Returns Background

withBorderRightColor

withBorderRightColor(value: Color): Background
Parameter Default Description
value

Returns Background

withBorderRightWidth

withBorderRightWidth(value: number): Background
Parameter Default Description
value
number

Returns Background

withBorderTopColor

withBorderTopColor(value: Color): Background
Parameter Default Description
value

Returns Background

withBorderTopLeftRadius

withBorderTopLeftRadius(value: number): Background
Parameter Default Description
value
number

Returns Background

withBorderTopRightRadius

withBorderTopRightRadius(value: number): Background
Parameter Default Description
value
number

Returns Background

withBorderTopWidth

withBorderTopWidth(value: number): Background
Parameter Default Description
value
number

Returns Background

withBoxShadow

withBoxShadow(value: CSSShadow): Background
Parameter Default Description
value
CSSShadow

Returns Background

withClipPath

withClipPath(value: string): Background
Parameter Default Description
value
string

Returns Background

withColor

withColor(value: Color): Background
Parameter Default Description
value

Returns Background

withImage

withImage(value: string | LinearGradient): Background
Parameter Default Description
value
string | LinearGradient

Returns Background

withPosition

withPosition(value: string): Background
Parameter Default Description
value
string

Returns Background

withRepeat

withRepeat(value: BackgroundRepeatType): Background

withSize

withSize(value: string): Background
Parameter Default Description
value
string

Returns Background

equals

Static
equals(value1: Background, value2: Background): boolean
Parameter Default Description
value1

value2

Returns boolean