Skip to navigation

PolyLineOverlayTab

View as Markdown
global class PolyLineOverlayTab extends Tab
Description
This type of tab enables the recipient to strike through document text. This value can't be set.
overlayType
global String overlayType
The type of overlay to use. The API currently supports only the outline overlay type.
polyLines
global List<PolyLine> polyLines
An array of poly-line objects that contain x- and y-coordinates representing the locations of the lines.

Methods

Description
Constructs a poly-line overlay tab.
global PolyLineOverlayTab withOverlayType(final String overlayType)
Description
Updates the tab overlayType property.
Returns
The tab with an updated overlayType value.
Parameters
overlayType
final String overlayType
The type of overlay to use.
global PolyLineOverlayTab withPolyLines(final List<PolyLine> polyLines)
Description
Updates the tab polyLines property.
Returns
The tab with an updated polyLines value.
Parameters
polyLines
final List<PolyLine> polyLines
An array of poly-line objects that contain x- and y-coordinates representing the locations of the lines.

PolyLineOverlayTab.PolyLine

global class PolyLine
Description
X- and y-coordinates representing the locations of the lines.
x1
global Integer x1
Start x coordinate.
x2
global Integer x2
End x coordinate.
y1
global Integer y1
Start y coordinate.
y2
global Integer y2
End y coordinate.

Methods

global PolyLine(final Integer x1, final Integer y1, final Integer x2, final Integer y2)
Description
Constructs a poly-line.
Parameters
x1
final Integer x1
Start x coordinate.
y1
final Integer y1
Start y coordinate.
x2
final Integer x2
End x coordinate.
y2
final Integer y2
End y coordinate.