BoxShadow | Swim Toolkit

Hierarchy

BoxShadow

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BoxShadow(inset: boolean, offsetX: Length, offsetY: Length, blurRadius: Length, spreadRadius: Length, color: Color, next: null | BoxShadow): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:15
Parameters
- inset: boolean
- offsetX: Length
- offsetY: Length
- blurRadius: Length
- spreadRadius: Length
- color: Color
- next: null | BoxShadow
Returns BoxShadow

Properties

Readonly blurRadius

blurRadius: Length

Readonly color

color: Color

Readonly inset

inset: boolean

Readonly next

next: null | BoxShadow

Readonly offsetX

offsetX: Length

Readonly offsetY

offsetY: Length

Readonly spreadRadius

spreadRadius: Length

Readonly stringValue

stringValue: undefined | string

Methods

and

and(value: AnyBoxShadow): BoxShadow
and(offsetX: AnyLength, offsetY: AnyLength, color: AnyColor): BoxShadow
and(offsetX: AnyLength, offsetY: AnyLength, blurRadius: AnyLength, color: AnyColor): BoxShadow
and(offsetX: AnyLength, offsetY: AnyLength, blurRadius: AnyLength, spreadRadius: AnyLength, color: AnyColor): BoxShadow
and(inset: boolean, offsetX: AnyLength, offsetY: AnyLength, color: AnyColor): BoxShadow
and(inset: boolean, offsetX: AnyLength, offsetY: AnyLength, blurRadius: AnyLength, color: AnyColor): BoxShadow
and(inset: boolean, offsetX: AnyLength, offsetY: AnyLength, blurRadius: AnyLength, spreadRadius: AnyLength, color: AnyColor): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:30
Parameters
- value: AnyBoxShadow
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:31
Parameters
- offsetX: AnyLength
- offsetY: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:32
Parameters
- offsetX: AnyLength
- offsetY: AnyLength
- blurRadius: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:33
Parameters
- offsetX: AnyLength
- offsetY: AnyLength
- blurRadius: AnyLength
- spreadRadius: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:34
Parameters
- inset: boolean
- offsetX: AnyLength
- offsetY: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:35
Parameters
- inset: boolean
- offsetX: AnyLength
- offsetY: AnyLength
- blurRadius: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:36
Parameters
- inset: boolean
- offsetX: AnyLength
- offsetY: AnyLength
- blurRadius: AnyLength
- spreadRadius: AnyLength
- color: AnyColor
Returns BoxShadow

equals

equals(that: unknown): boolean

Implementation of Equals.equals
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:40
Parameters
- that: unknown
Returns boolean

equivalentTo

equivalentTo(that: unknown, epsilon?: number): boolean

Implementation of Equivalent.equivalentTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:39
Parameters
- that: unknown
- Optional epsilon: number
Returns boolean

interpolateTo

interpolateTo(that: BoxShadow): Interpolator<BoxShadow>
interpolateTo(that: unknown): null | Interpolator<BoxShadow>

Implementation of Interpolate.interpolateTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:37
Parameters
- that: BoxShadow
Returns Interpolator<BoxShadow>
Implementation of Interpolate.interpolateTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:38
Parameters
- that: unknown
Returns null | Interpolator<BoxShadow>

toString

toString(): string

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:42
Returns string

withBlurRadius

withBlurRadius(blurRadius: AnyLength): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:24
Parameters
- blurRadius: AnyLength
Returns BoxShadow

withColor

withColor(color: AnyColor): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:28
Parameters
- color: AnyColor
Returns BoxShadow

withInset

withInset(inset: boolean): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:18
Parameters
- inset: boolean
Returns BoxShadow

withOffsetX

withOffsetX(offsetX: AnyLength): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:20
Parameters
- offsetX: AnyLength
Returns BoxShadow

withOffsetY

withOffsetY(offsetY: AnyLength): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:22
Parameters
- offsetY: AnyLength
Returns BoxShadow

withSpreadRadius

withSpreadRadius(spreadRadius: AnyLength): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:26
Parameters
- spreadRadius: AnyLength
Returns BoxShadow

Static create

create(value: AnyBoxShadow): BoxShadow
create(offsetX: AnyLength, offsetY: AnyLength, color: AnyColor): BoxShadow
create(offsetX: AnyLength, offsetY: AnyLength, blurRadius: AnyLength, color: AnyColor): BoxShadow
create(offsetX: AnyLength, offsetY: AnyLength, blurRadius: AnyLength, spreadRadius: AnyLength, color: AnyColor): BoxShadow
create(inset: boolean, offsetX: AnyLength, offsetY: AnyLength, color: AnyColor): BoxShadow
create(inset: boolean, offsetX: AnyLength, offsetY: AnyLength, blurRadius: AnyLength, color: AnyColor): BoxShadow
create(inset: boolean, offsetX: AnyLength, offsetY: AnyLength, blurRadius: AnyLength, spreadRadius: AnyLength, color: AnyColor): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:43
Parameters
- value: AnyBoxShadow
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:44
Parameters
- offsetX: AnyLength
- offsetY: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:45
Parameters
- offsetX: AnyLength
- offsetY: AnyLength
- blurRadius: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:46
Parameters
- offsetX: AnyLength
- offsetY: AnyLength
- blurRadius: AnyLength
- spreadRadius: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:47
Parameters
- inset: boolean
- offsetX: AnyLength
- offsetY: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:48
Parameters
- inset: boolean
- offsetX: AnyLength
- offsetY: AnyLength
- blurRadius: AnyLength
- color: AnyColor
Returns BoxShadow
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:49
Parameters
- inset: boolean
- offsetX: AnyLength
- offsetY: AnyLength
- blurRadius: AnyLength
- spreadRadius: AnyLength
- color: AnyColor
Returns BoxShadow

Static form

form(): Form<null | BoxShadow, AnyBoxShadow>

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:58
Returns Form<null | BoxShadow, AnyBoxShadow>

Static fromAny

fromAny(...values: AnyBoxShadow[]): null | BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:52
Parameters
- Rest ...values: AnyBoxShadow[]
Returns null | BoxShadow

Static fromArray

fromArray(array: readonly BoxShadow[]): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:51
Parameters
- array: readonly BoxShadow[]
Returns BoxShadow

Static fromInit

fromInit(init: BoxShadowInit): BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:50
Parameters
- init: BoxShadowInit
Returns BoxShadow

Static fromValue

fromValue(value: Value): null | BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:53
Parameters
- value: Value
Returns null | BoxShadow

Static isAny

isAny(value: unknown): value is AnyBoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:57
Parameters
- value: unknown
Returns value is AnyBoxShadow

Static isArray

isArray(value: unknown): value is readonly BoxShadow[]

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:56
Parameters
- value: unknown
Returns value is readonly BoxShadow[]

Static isInit

isInit(value: unknown): value is BoxShadowInit

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:55
Parameters
- value: unknown
Returns value is BoxShadowInit

Static parse

parse(string: string): null | BoxShadow

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/shadow/BoxShadow.d.ts:54
Parameters
- string: string
Returns null | BoxShadow

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

inset: boolean

offsetX: Length

offsetY: Length

blurRadius: Length

spreadRadius: Length

color: Color

next: null | BoxShadow

Returns BoxShadow

Properties

Readonly blurRadius

Readonly color

Readonly inset

Readonly next

Readonly offsetX

Readonly offsetY

Readonly spreadRadius

Readonly stringValue

Methods

and

Parameters

value: AnyBoxShadow

Returns BoxShadow

Parameters

offsetX: AnyLength

offsetY: AnyLength

color: AnyColor

Returns BoxShadow

Parameters

offsetX: AnyLength

offsetY: AnyLength

blurRadius: AnyLength

color: AnyColor

Returns BoxShadow

Parameters

offsetX: AnyLength

offsetY: AnyLength

blurRadius: AnyLength

spreadRadius: AnyLength

color: AnyColor

Returns BoxShadow

Parameters

inset: boolean

offsetX: AnyLength

offsetY: AnyLength

color: AnyColor

Returns BoxShadow

Parameters

inset: boolean

offsetX: AnyLength

offsetY: AnyLength

blurRadius: AnyLength

color: AnyColor

Returns BoxShadow

Parameters

inset: boolean

offsetX: AnyLength

offsetY: AnyLength

blurRadius: AnyLength

spreadRadius: AnyLength

color: AnyColor

Returns BoxShadow

equals

Parameters

that: unknown

Returns boolean

equivalentTo

Parameters

that: unknown

Optional epsilon: number

Returns boolean

interpolateTo