page_element_property: Common Property: Page Element Property

Description Usage Arguments Value Examples

View source: R/commonProperties.R

Description

This property is repeated in various of the request. Hence, to reduce the number of times this would appear in the code base, a function is created to handle the creation of this list.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
page_element_property(
  page_object_id = NULL,
  width_magnitude = NULL,
  height_magnitude = NULL,
  scale_x = NULL,
  scale_y = NULL,
  shear_x = NULL,
  shear_y = NULL,
  translate_x = NULL,
  translate_y = NULL,
  width_unit = "PT",
  height_unit = "PT",
  transform_unit = "PT"
)

Arguments

page_object_id

A character vector that contains the page id of the slide

width_magnitude

(Optional) A numeric vector that contains the width of the component

height_magnitude

(Optional) A numeric vector that contains the height of the component

scale_x

(Optional) A numeric vector that tells how the object is to be sized

scale_y

(Optional) A numeric vector that tells how the object is to be sized

shear_x

(Optional) A numeric vector that tells how the object is to be sheared

shear_y

(Optional) A numeric vector that tells how the object is to be sheared

translate_x

(Optional) A numeric vector that tells how the object is to be located

translate_y

(Optional) A numeric vector that tells how the object is to be located

width_unit

(Optional) A string vector that tells the measurement unit to use to locate the elements on the slide for the width element

height_unit

(Optional) A string vector that tells the measurement unit to use to locate the elements on the slide for the height element

transform_unit

(Optional) A string vector that tells the measurement unit to use to locate the elements on the slide for the transform element

Value

A PageElementProperty Object

Examples

1
2
3
4
5
6
7
8
## Not run: 
library(googleslides)

# There is only one compulsory field which is pageObjectId is the
# 'slide id' of the slide being referenced to
pageElementProperty <- page_element_property("12345")

## End(Not run)

sparklineanalytics/rgoogleslides documentation built on Nov. 9, 2021, 3:42 a.m.