overlay: Overlay

Description Usage Arguments Value

Description

A list of overlays can be added to existing elements in the diagram. See overlays argument in bpmn function. Use this structure to create correct overlay structure.

Usage

1
2
overlay(element, html, type = "note", left = NULL, right = NULL,
  top = NULL, bottom = NULL, min_zoom = NULL, max_zoom = NULL)

Arguments

element

The bpmn element to which the overlay will be attached

html

HTML element to use as an overlay to use as an overlay

type

Optional type to assign to the overlay

left

Where to attach the overlay, relative to element bbox left attachment

right

Where to attach the overlay, relative to element bbox right attachment

top

Where to attach the overlay, relative to element bbox top attachment

bottom

where to attach the overlay, relative to element bbox bottom attachment

min_zoom

minimal zoom level to show the overlay

max_zoom

maximum zoom level to show the overlay

Value

An overlay object


bergant/bpmn documentation built on May 20, 2019, 5:05 p.m.