new module:model/PolyLineOverlay()
- Source:
Constructs a new PolyLineOverlay.
This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.
Members
(inner) anchorAllowWhiteSpaceInCharacters :String
- Source:
Type:
- String
(inner) anchorAllowWhiteSpaceInCharactersMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the anchorAllowWhiteSpaceInCharacters property is editable.
Type:
(inner) anchorCaseSensitive :String
- Source:
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.
Type:
- String
(inner) anchorCaseSensitiveMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the anchorCaseSensitive property is editable.
Type:
(inner) anchorHorizontalAlignment :String
- Source:
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.
Type:
- String
(inner) anchorHorizontalAlignmentMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the anchorHorizontalAlignment property is editable.
Type:
(inner) anchorIgnoreIfNotPresent :String
- Source:
When set to true, this tab is ignored if anchorString is not found in the document.
Type:
- String
(inner) anchorIgnoreIfNotPresentMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.
Type:
(inner) anchorMatchWholeWord :String
- Source:
When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.
Type:
- String
(inner) anchorMatchWholeWordMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the anchorMatchWholeWord property is editable.
Type:
(inner) anchorString :String
- Source:
Anchor text information for a radio button.
Type:
- String
(inner) anchorStringMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the anchorString property is editable.
Type:
(inner) anchorTabProcessorVersion :String
- Source:
Type:
- String
(inner) anchorTabProcessorVersionMetadata :module:model/PropertyMetadata
- Source:
Reserved for DocuSign.
Type:
(inner) anchorUnits :String
- Source:
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
Type:
- String
(inner) anchorUnitsMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the anchorUnits property is editable.
Type:
(inner) anchorXOffset :String
- Source:
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
Type:
- String
(inner) anchorXOffsetMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the anchorXOffset property is editable.
Type:
(inner) anchorYOffset :String
- Source:
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
Type:
- String
(inner) anchorYOffsetMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the anchorYOffset property is editable.
Type:
(inner) caption :String
- Source:
Type:
- String
(inner) captionMetadata :module:model/PropertyMetadata
- Source:
Type:
(inner) conditionalParentLabel :String
- Source:
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
Type:
- String
(inner) conditionalParentLabelMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the conditionalParentLabel property is editable.
Type:
(inner) conditionalParentValue :String
- Source:
For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.
Type:
- String
(inner) conditionalParentValueMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the conditionalParentValue property is editable.
Type:
(inner) customTabId :String
- Source:
The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
Type:
- String
(inner) customTabIdMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the customTabId property is editable.
Type:
(inner) documentId :String
- Source:
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
Type:
- String
(inner) documentIdMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the documentId property is editable.
Type:
(inner) errorDetails :module:model/ErrorDetails
- Source:
Array or errors.
Type:
(inner) formOrder :String
- Source:
Type:
- String
(inner) formOrderMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the formOrder property is editable.
Type:
(inner) formPageLabel :String
- Source:
Type:
- String
(inner) formPageLabelMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the formPageLabel property is editable.
Type:
(inner) formPageNumber :String
- Source:
Type:
- String
(inner) formPageNumberMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the fromPageNumber property is editable.
Type:
(inner) graphicsContext :module:model/GraphicsContext
- Source:
Contains details about the style used for the strike through graphic.
Type:
(inner) height :String
- Source:
Height of the tab in pixels.
Type:
- String
(inner) heightMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the height property is editable.
Type:
(inner) locked :String
- Source:
When set to true, the signer cannot change the data of the custom tab.
Type:
- String
(inner) lockedMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the locked property is editable.
Type:
(inner) mergeField :module:model/MergeField
- Source:
Contains the information necessary to map the tab to a field in SalesForce.
Type:
(inner) mergeFieldXml :String
- Source:
Type:
- String
(inner) overlayType :String
- Source:
Type:
- String
(inner) overlayTypeMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the overlayType property is editable.
Type:
(inner) pageNumber :String
- Source:
Specifies the page number on which the tab is located.
Type:
- String
(inner) pageNumberMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the pageNumber property is editable.
Type:
(inner) polyLines :Array.<module:model/PolyLine>
- Source:
Type:
- Array.<module:model/PolyLine>
(inner) recipientId :String
- Source:
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
Type:
- String
(inner) recipientIdGuid :String
- Source:
Type:
- String
(inner) recipientIdGuidMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the recipientIdGuid property is editable.
Type:
(inner) recipientIdMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the recipientId property is editable.
Type:
(inner) shared :String
- Source:
When set to true, this custom tab is shared.
Type:
- String
(inner) sharedMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the shared property is editable.
Type:
(inner) smartContractInformation :module:model/SmartContractInformation
- Source:
Reserved for DocuSign.
Type:
(inner) source :String
- Source:
Type:
- String
(inner) status :String
- Source:
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
Type:
- String
(inner) statusMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the status property is editable.
Type:
(inner) tabGroupLabels :Array.<String>
- Source:
Type:
- Array.<String>
(inner) tabGroupLabelsMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the tabGroupLabels property is editable.
Type:
(inner) tabId :String
- Source:
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
Type:
- String
(inner) tabIdMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the tabId property is editable.
Type:
(inner) tabLabel :String
- Source:
The label string associated with the tab.
Type:
- String
(inner) tabOrder :String
- Source:
Type:
- String
(inner) tabOrderMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the tabOrder property is editable.
Type:
(inner) tabType :String
- Source:
Type:
- String
(inner) tabTypeMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the tabType property is editable.
Type:
(inner) templateLocked :String
- Source:
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
Type:
- String
(inner) templateLockedMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the templateLocked property is editable.
Type:
(inner) templateRequired :String
- Source:
When set to true, the sender may not remove the recipient. Used only when working with template recipients.
Type:
- String
(inner) templateRequiredMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the templateRequired property is editable.
Type:
(inner) tooltip :String
- Source:
Type:
- String
(inner) toolTipMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the toolTip property is editable.
Type:
(inner) width :String
- Source:
Width of the tab in pixels.
Type:
- String
(inner) widthMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the width property is editable.
Type:
(inner) xPosition :String
- Source:
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
Type:
- String
(inner) xPositionMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the xPosition property is editable.
Type:
(inner) yPosition :String
- Source:
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
Type:
- String
(inner) yPositionMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the yPosition property is editable.
Type:
Methods
(static) constructFromObject(data, obj) → {module:model/PolyLineOverlay}
- Source:
Constructs a PolyLineOverlay from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/PolyLineOverlay | Optional instance to populate. |
Returns:
The populated PolyLineOverlay instance.