Background

class cee.Background()

Background configuration

The class defines the view background settings. The background can either be single colored or be a gradient between a top and a bottom color. Image backgrounds are also supported, in which case the image will be rendered on top of the specified background color.

You can access the background object from the remote model with the RemoteModel.background property.

Accessors

Methods

Accessors

cee.Background.bottomColor

The bottom color of the background.

If background is single color, the topColor and bottomColor properties are equal

cee.Background.image

If image background is in use it returns the image uses as a background.

cee.Background.topColor

The top color of the background.

If background is single color, the topColor and bottomColor properties are equal

Methods

setImage

cee.Background.setImage(texture)

Use the given image as the background of the view

Arguments

  • texture ({  }) –

Return type

void

Specify null to clear any previously specified background image.

setSingleColor

cee.Background.setSingleColor(color)

Sets the background color to the given color (single color)

Arguments
Return type

void

The background of the view will be cleared with the given color, and no graded background will be rendered. This is the default mode.

setTopAndBottomColor

cee.Background.setTopAndBottomColor(topColor, bottomColor)

Sets the background color to a gradient defined by a top color and a bottom color

Arguments
Return type

void