Title

Global

Type Definitions

ActionAttachmentOptions

Configuration object for file attachment in the generateReport action. A configuration object must be complete. If there is no valid page specified the attribute and custom type will be ignored

Properties:
Name Type Attributes Description
page String | Page <optional>

Page id/uid of the page to attach the generated file to or a page object

attribute String <optional>

Attribute name to attach the generated file to

customType String <optional>

Internal name of the file type for generating the file

Since:
  • 5.5
Example
{
    page: '12345',
    attribute: 'generatedReports',
    customType: 'geratedReportDocument'
  }
Object

Actions

Special functions that can be called from cplaceJS code. Actions are generally used to modify an entity in cplace.

See:
*

ArrayLike

An object containing other objects which can be iterated over. This can be an Array, a List or a Set for example.

Object

BorderConfig

Although a border config should have at least one property all properties are optional.

Properties:
Name Type Attributes Description
color string | number | Array.<number> <optional>

The color of the border. This can be either a string describing a 24-bit opaque color, an array providing byte values for the color's red, green and blue values or a 24-bit integer.

visible boolean <optional>

Whether the border should be displayed or not.

width number <optional>

The width of the border.

Since:
  • 5.0
Examples
{
  color  : "#0120AA",
  visible: true,
  width  : 2
}
{
  color: 0x2365dc, // using a 24-bit integer
  width: 12
}
{
  color: [0, 128, 255] // using an array for RGB values
}
Object

CellStyle

Properties:
Name Type Attributes Description
color string | number | Array.<number> <optional>

The background color This can be either a string describing a 24-bit opaque color, an array providing byte values for the color's red, green and blue values or a 24-bit integer.

fill 'solid' | 'pattern' | 'gradient'

The fill type of the cell background.

gradientStops Array.<GradientStop> <optional>

The gradient stops to use when the fill is set to 'gradient'.

font FontConfig <optional>

Configuration for the font to use for the cell.

cellsToMerge number <optional>

Number of cells to the right to merge.

trimAfterMerge boolean <optional>

Whether string content should be trimmed after merging cells.

rightBorder BorderConfig <optional>

Configuration for the right cell border.

leftBorder BorderConfig <optional>

Configuration for the left cell border.

topBorder BorderConfig <optional>

Configuration for the top cell border.

bottomBorder BorderConfig <optional>

Configuration for the bottom cell border.

imageAlignment ImageAlignment <optional>

Alignment for image in cell

imageScaling ImageScaling | string <optional>

Configuration for scaling of image - if no scaling should be applied, the string "none" muse be used as value of this property

Since:
  • 5.0
Example
{
  "color": [0, 255, 0],
  "fill": "gradient",
  "gradientStops" : [
    {
      "color" : "#ff000",
      "position": 0.00
    },
    {
      "color" : "#cc000",
      "position": 0.33
    },
    {
      "color" : "#99330",
      "position": 0.66
    },
    {
      "color" : "#66660",
      "position": 1.00
    },
  ],
  "font":
  {
    "family": "whatever",
    "size": 10,
    "color": "#ff0000",
    "style": "italic, underline"
  },
  "cellsToMerge" : 1,
  "trimAfterMerge": false,
  "rightBorder" : {
    "color" : "#0000ff",
    "width" : 2.5,
    "visible" : true
  },
  "imageAlignment": {
    "horizontal": "left",
    "vertical": "boTTom"
  },
  "imageScaling": {
    "horizontal": "40%",
    "vertical": "70%"
  }
}
Object

CustomAttributes

Object defines structure of CustomAttributes. Type of value depends on the type of CustomAttribute. Setting null explicitly will remove the value from attribute If an attributes has internal representation of values(Enums workflow states, etc), internal representation must be provided as values.

Object

FontConfig

Although all properties are optional a font config should have at least one meaningful setting.

Properties:
Name Type Attributes Description
family string <optional>

The name of the font family.

size number <optional>

The size of the text in pt

color string | number | Array.<number> <optional>

The color of the border. This can be either a string describing a 24-bit opaque color, an array providing byte values for the color's red, green and blue values or a 24-bit integer.

style string <optional>

A comma separated list of font styles to apply. Supported values are 'bold', 'italic', 'underline', and 'strikethrough'. Unknown strings are ignored

Since:
  • 5.0
Example
{
  family: "Wingdings",
  size  : 24,
  color : "#034FCA",
  style : "bold, underline"
}
Object

GradientStop

Properties:
Name Type Description
color string

The string representation of a 24-bit opaque color

position number | string

A value in the range of [0, 1] describing the gradient stop or a percentage string.

Since:
  • 5.0
Examples
{
  color   : "#AFFE00",
  position: 0.13
}
{
  color   : "#F00BAA",
  position: "42%"
}
Object

ImageAlignment

Although an image alignment config should have at least one property all properties are optional. Default alignment if none is specified is 'CENTER'

Properties:
Name Type Attributes Description
horizontal string <optional>

The horizontal alignment of the image inside the cell. This must be one of (case-independent) 'LEFT', 'CENTER' or 'RIGHT'

vertical string <optional>

The vertical alignment of the image inside the cell. This must be one of (case-independent) 'TOP', 'CENTER' or 'BOTTOM'

Since:
  • 5.0
Example
{
    "horizontal": "left",
    "vertical": "bottom"
  }
Object

ImageScaling

Image scaling config to specify size of image relative to cell height and width. If image should not be scaled at all, provide string "none" instead of this object

Properties:
Name Type Attributes Description
horizontal number | string <optional>

The horizontal scaling factor. Either a number between 0 and 1 or a string containing a percentage between "0%" and "100%".

vertical number | string <optional>

The vertical scaling factor. Either a number between 0 and 1 or a string containing a percentage between "0%" and "100%".

Since:
  • 5.0
Example
{
    "horizontal": "60%",
    "vertical": 0.8
  }

IteratingFunction(item) → {boolean}

A function that performs an operation on an provided item. Usually used in loops over iterables, e.g. in cplace.each

Parameters:
Name Type Description
item *

an item from to perform the operation on.

false to interrupt the loop undefined else (no return statement is sufficient).

boolean
Object

LocalizedString

A localized string object containing language dependant versions of a string.

Properties:
Name Type Description
de string

german translation/version of the string

en string

english translation/version of the string

MappingFunction(item) → {*}

Transformation function that maps data.

Parameters:
Name Type Description
item *

the item to transform.

The transformed item.

*
Object

NotificationOptions

An object that defines all the data for a notification

Properties:
Name Type Attributes Default Description
message string | LocalizedString

the message of the notification

title string | LocalizedString <optional>

the title of the notification. If it is missing the whole header row including the icon won't be displayed.

icon string <optional>

an icon to display in the header row. Display depends on the presence of the title.

isCritical boolean <optional>
false

whether the notification is handled and rendered as critical/important. Defaults to false.

target string | Page <optional>

the page to forward to when the user clicks the notification.

recipients string | Person | Group | SystemGroup | Array.<(string|Person|Group|SystemGroup)> <optional>
current_user

person or people to receive the notification. If provided as an array tpyes may be mixed e.g. [person, group]. Defaults to current user. Note that for system groups only the "all users" group is supported.

Object

PageData

An object that defines all the data for a page.

Properties:
Name Type Attributes Description
name string <optional>

name of the page

spaceId string <optional>

id of the space, in which, the page will be created. Not needed when updating page.

type string <optional>

custom type of the page. Not needed when updating page.

layoutName string <optional>

internal name of the layout to set.

customAttributes CustomAttributes <optional>

custom attributes of the page

permissions PagePermissions <optional>

Permission settings for the page.

Object

PageOptions

Options for createPage and updatePage actions

Properties:
Name Type Description
setGeneratedName boolean

generate name of the page using defined name generation pattern

Object

PagePermissions

Object defines structure of PagePermissions. Type of value depends on the type of PagePermissions.

Properties:
Name Type Description
readers 'inherited' | Array | PermissionsObject
writers 'inherited' | Array | Object
deputies 'inherited' | Array | Object
Object

PermissionsObject

Structure for providing permissions for pages

Properties:
Name Type Attributes Description
additiveInheritance boolean <optional>

Flag to control additive permission inheritance.

plus Array

the actual key is '+'. Principals ids to add

minus Array

the actual key is '-'. Principals ids to remove

Object

SearchFilter

Filter for search

Example
var search = new Search();
search.add(Filters.space('83ih886l6870t7oj18r9k8hvt'));
// this will add a filter to search that will limit the search to provided space id
Object

SendMailData

An object which defines all data for sending an email

Properties:
Name Type Attributes Description
fromAddress string <optional>

sender address

fromName string <optional>

sender name

to string

recipient mail address

subject string

mail subject (can contain placeholders, syntax is cplace template language)

message string

mail message (can contain placeholders, syntax is cplace template language)

substitutions Object <optional>

substitution values for placeholders in subject and message parameter. Type of substitution used depends on the type of value: Values of type boolean will be used as conditional substitution. Values of type array will be used as list substitution. When the array contains generic Objects, the property keys of the first element are used as keys for the print substitions of each element. When the array contains another type of data, the value will be converted to string and be made accessible under key 'value'. All other values will be used as print substitution.

Object

TextConfig

Configuration object for text components.

Properties:
Name Type Attributes Description
text string

The text to display on the component

limit number <optional>

Length after which the text is truncated. This is only applied if the text exceeds the limit.

bulletStyle string <optional>

Style/glyph to use for list bullets. Text will be rendered as a bullet list. See TextComponent.asBulletList for possible values.

font FontConfig <optional>

Font style to apply to the component.

Since:
  • 5.0
See:
Object

Utilities

Special utility functions that can be called from cplaceJS code. Utilities do NOT modify entities in cplace.

See:
Object

WorksheetBackground

An object which holds configurations for the background text

Properties:
Name Type Attributes Description
rotation number <optional>

the rotation of the background text

margin number <optional>

the margin of the background text to the next text

font WorksheetBackgroundFont <optional>

the font of the background text

Object

WorksheetBackgroundConfiguration

An object which holds the new name and background color of an excel worksheet or an image file which will be used as background image. The image will only be used if no text is provided

Properties:
Name Type Attributes Description
text string | WorksheetBackground <optional>

the text of the background

image Document <optional>

holding an image

Object

WorksheetBackgroundFont

An object which holds configurations for the font of the background text

Properties:
Name Type Attributes Description
family string <optional>

the font of the background text

size number <optional>

the size of the background text

Object

WorksheetConfiguration

An object which holds the new name and background color of an excel worksheet

Properties:
Name Type Attributes Description
name string <optional>

the new name of the excel worksheet

color Array.<number> | string | number <optional>

the new background color of the excel worksheet

background WorksheetBackgroundConfiguration
Object

WrappedWorkflowTransition

Wrapper object for transition meta information.

Properties:
Name Type Description
displayName string

The display name of the transition

nextStateInternalName string

The internal name of the state to transition to.

nextStateDisplayName string

The display name of the state to transition to.

previousStateInternalName string

The internal name of the state the transition was initiated from.

previousStateDisplayName string

The display name of the state the transition was initiated from.

Since:
  • 4.57