garcon: Garcon

Description Usage Methods Examples

Description

Create a garcon to aniamte images on the waiter.

Usage

1

Methods

Public methods


Method new()

Usage
Garcon$new(
  image,
  bg_color = "#FFFFFF",
  opacity = 0.5,
  direction = c("bt", "tb", "lr", "rl"),
  filter = NULL
)
Arguments
image

The CSS id of the image tag.

bg_color

Background overlay color in hexadecimal or RGB.

opacity

Overlay transparency.

direction

Animation direction. Possible values: lr (left to right), rl (right to left), bt (bottom to top), tb (top to bottom).

filter

Filter to apply, options are blur, grayscale, sepia, hue-rotate, invert, opacity.

Details

Initialise the garçon.

Examples
\dontrun{Garcon$new("img")$set(30)}

Method set()

Usage
Garcon$set(value)
Arguments
value

Percentage to set to.

Details

Value to set the garçon to.

Examples
\dontrun{Garcon$new("img")$set(30)}

Method inc()

Usage
Garcon$inc(value)
Arguments
value

Percentage to increase to.

Details

Value to increase the garçon to.

Examples
\dontrun{Garcon$new("img")$inc(30)}

Method reset()

Usage
Garcon$reset(value)
Arguments
value

Percentage to set to.

Details

Reset the garçon to.

Examples
\dontrun{Garcon$new("img")$set(30)$reset()}

Method destroy()

Usage
Garcon$destroy()
Details

Kill the garçon to.

Examples
\dontrun{Garcon$new("img")$set(30)$destroy()}

Method print()

Usage
Garcon$print()
Details

print the garcon


Method stop()

Usage
Garcon$stop()
Details

Stop the garçon.

Examples
\dontrun{Garcon$new("img")$set(30)$stop()}

Method close()

Usage
Garcon$close()
Details

Close the garçon.

Examples
\dontrun{Garcon$new("img")$set(30)$close()}

Method clone()

The objects of this class are cloneable with this method.

Usage
Garcon$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
## ------------------------------------------------
## Method `Garcon$new`
## ------------------------------------------------

## Not run: Garcon$new("img")$set(30)

## ------------------------------------------------
## Method `Garcon$set`
## ------------------------------------------------

## Not run: Garcon$new("img")$set(30)

## ------------------------------------------------
## Method `Garcon$inc`
## ------------------------------------------------

## Not run: Garcon$new("img")$inc(30)

## ------------------------------------------------
## Method `Garcon$reset`
## ------------------------------------------------

## Not run: Garcon$new("img")$set(30)$reset()

## ------------------------------------------------
## Method `Garcon$destroy`
## ------------------------------------------------

## Not run: Garcon$new("img")$set(30)$destroy()

## ------------------------------------------------
## Method `Garcon$stop`
## ------------------------------------------------

## Not run: Garcon$new("img")$set(30)$stop()

## ------------------------------------------------
## Method `Garcon$close`
## ------------------------------------------------

## Not run: Garcon$new("img")$set(30)$close()

waiter documentation built on Jan. 8, 2021, 2:15 a.m.