Skip to content

Latest commit

Β 

History

History
870 lines (518 loc) Β· 16.2 KB

Background.md

File metadata and controls

870 lines (518 loc) Β· 16.2 KB
title Background
titleTemplate title - API / NativeScript
contributors false

Defined in: ui/styling/background-common.ts

Constructors

Constructor

new Background(): Background;

Returns

Background

Properties

borderBottomColor

borderBottomColor: Color;

Defined in: ui/styling/background-common.ts


borderBottomLeftRadius

borderBottomLeftRadius: number;

Defined in: ui/styling/background-common.ts


borderBottomRightRadius

borderBottomRightRadius: number;

Defined in: ui/styling/background-common.ts


borderBottomWidth

borderBottomWidth: number;

Defined in: ui/styling/background-common.ts


borderLeftColor

borderLeftColor: Color;

Defined in: ui/styling/background-common.ts


borderLeftWidth

borderLeftWidth: number;

Defined in: ui/styling/background-common.ts


borderRightColor

borderRightColor: Color;

Defined in: ui/styling/background-common.ts


borderRightWidth

borderRightWidth: number;

Defined in: ui/styling/background-common.ts


borderTopColor

borderTopColor: Color;

Defined in: ui/styling/background-common.ts


borderTopLeftRadius

borderTopLeftRadius: number;

Defined in: ui/styling/background-common.ts


borderTopRightRadius

borderTopRightRadius: number;

Defined in: ui/styling/background-common.ts


borderTopWidth

borderTopWidth: number;

Defined in: ui/styling/background-common.ts


boxShadows

boxShadows: BoxShadow[];

Defined in: ui/styling/background-common.ts


clearFlags

clearFlags: number;

Defined in: ui/styling/background-common.ts


clipPath

clipPath: string | ClipPathFunction;

Defined in: ui/styling/background-common.ts


color

color: Color;

Defined in: ui/styling/background-common.ts


cornerShape

cornerShape: CornerShapeType;

Defined in: ui/styling/background-common.ts


image

image: string | LinearGradient;

Defined in: ui/styling/background-common.ts


position

position: string;

Defined in: ui/styling/background-common.ts


repeat

repeat: BackgroundRepeatType;

Defined in: ui/styling/background-common.ts


size

size: string;

Defined in: ui/styling/background-common.ts


default

static default: Background;

Defined in: ui/styling/background-common.ts

Methods

getBoxShadows()

getBoxShadows(): BoxShadow[];

Defined in: ui/styling/background-common.ts

Returns

BoxShadow[]


getUniformBorderColor()

getUniformBorderColor(): Color;

Defined in: ui/styling/background-common.ts

Returns

Color


getUniformBorderRadius()

getUniformBorderRadius(): number;

Defined in: ui/styling/background-common.ts

Returns

number


getUniformBorderWidth()

getUniformBorderWidth(): number;

Defined in: ui/styling/background-common.ts

Returns

number


hasBorder()

hasBorder(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


hasBorderColor()

hasBorderColor(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


hasBorderRadius()

hasBorderRadius(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


hasBorderWidth()

hasBorderWidth(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


hasBoxShadows()

hasBoxShadows(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


hasUniformBorder()

hasUniformBorder(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


hasUniformBorderColor()

hasUniformBorderColor(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


hasUniformBorderRadius()

hasUniformBorderRadius(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


hasUniformBorderWidth()

hasUniformBorderWidth(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


isEmpty()

isEmpty(): boolean;

Defined in: ui/styling/background-common.ts

Returns

boolean


toString()

toString(): string;

Defined in: ui/styling/background-common.ts

Returns

string


withBorderBottomColor()

withBorderBottomColor(value: Color): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value Color

Returns

Background


withBorderBottomLeftRadius()

withBorderBottomLeftRadius(value: number): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value number

Returns

Background


withBorderBottomRightRadius()

withBorderBottomRightRadius(value: number): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value number

Returns

Background


withBorderBottomWidth()

withBorderBottomWidth(value: number): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value number

Returns

Background


withBorderLeftColor()

withBorderLeftColor(value: Color): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value Color

Returns

Background


withBorderLeftWidth()

withBorderLeftWidth(value: number): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value number

Returns

Background


withBorderRightColor()

withBorderRightColor(value: Color): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value Color

Returns

Background


withBorderRightWidth()

withBorderRightWidth(value: number): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value number

Returns

Background


withBorderTopColor()

withBorderTopColor(value: Color): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value Color

Returns

Background


withBorderTopLeftRadius()

withBorderTopLeftRadius(value: number): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value number

Returns

Background


withBorderTopRightRadius()

withBorderTopRightRadius(value: number): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value number

Returns

Background


withBorderTopWidth()

withBorderTopWidth(value: number): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value number

Returns

Background


withBoxShadows()

withBoxShadows(value: BoxShadow[]): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value BoxShadow[]

Returns

Background


withClipPath()

withClipPath(value: string | ClipPathFunction): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value string | ClipPathFunction

Returns

Background


withColor()

withColor(value: Color): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value Color

Returns

Background


withCornerShape()

withCornerShape(value: CornerShapeType): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value CornerShapeType

Returns

Background


withImage()

withImage(value: string | LinearGradient): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value string | LinearGradient

Returns

Background


withPosition()

withPosition(value: string): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value string

Returns

Background


withRepeat()

withRepeat(value: BackgroundRepeatType): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value BackgroundRepeatType

Returns

Background


withSize()

withSize(value: string): Background;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value string

Returns

Background


equals()

static equals(value1: Background, value2: Background): boolean;

Defined in: ui/styling/background-common.ts

Parameters

Parameter Type
value1 Background
value2 Background

Returns

boolean