Readonly areaThe area of the field on the canvas as defined by the parameter. If the actual position is required, have a look at FieldBoundingBox and GetBoundingBox.
Flag to control if the field is visible or hidden. Flipped fields will be mirrored horizontally.
Flag to control if the field is vertically flipped or not. Flipped fields will be mirrored vertically.
The height of the field on the canvas. Value in points.
Flag to control if the field is visible or hidden. Hidden fields will not show in the UI and not on the output.
Readonly page: numberThe index of the page this field is on. The index is zero based.
The rotation of the field on the canvas. Value in degrees. The rotation center is the top left coordinate.
Readonly subFor spread setups only this is the index of the sub page. The index is zero based.
The width of the field on the canvas. Value in points.
The x coordinate of the field on the canvas. Value in points.
The y coordinate of the field on the canvas. Value in points.
Readonly zThe z-index of the field on the page. The z-index defines the order of the fields on the page. The higher the z-index, the more on top the field is.
The border object defines the field border settings - which includes not only the border itself but also the background fill of the field. This is available for all field types except path fields.
Readonly customThe custom object holds information specific to that field
Readonly canvasThe canvas background data to render on the output. This data is in an internal format. Use the CustomFieldCanvas to write this data via normal drawing commands.
Readonly canvasThe canvas data to render on the output. This data is in an internal format. Use the CustomFieldCanvas to write this data via normal drawing commands.
Readonly canvasThe canvas overlay data to render on the output. This data is in an internal format. Use the CustomFieldCanvas to write this data via normal drawing commands.
The data object is fully controlled by the script. It can be used to store any information needed by the script.
Readonly externalThe external resources used by the field. This is generated automatically during rendering via CustomFieldCanvas.
The scale factor of the field in relation to the document. This is used to scale the field to the correct size when rendering. Useful for higher resolution output. Default value is 2.
Readonly type: stringThis defines the specific type of the custom field as defined by a script. This is used to identify the code which will interact with this field.
Readonly idThe id of the field (GUID) as a unique identifier.
Readonly infoThe info or meta data details of the field.
The custom data is an arbitrary object which can be used to store additional information against the field. This is for scripting usage only. Note that there is only a single custom data object per field. So multiple scripts would have to consider a merge or overwrite strategy.
The name of the field. By default empty, this can be used to provide semantic information to the field and will be used for logging, errors and debugging, but can also be helpful for field retrieval. The name of a field doesn't have to be unique and duplicates can happen.
The sequence is used for auto mapping values when applying layouts. In order to determine which field of the new layout should be populated with the value of which field in the old layout the sequence is used. This is independent of creation order or z-index and allows to semantically control this. When generating fields the sequence is automatically set as an incrementing number.
The list of tags. Tags can be also used to retrieve fields and store additional meta data against the field. Note that a tag cannot contain the '|' character.
Readonly issuesThe issues object holds flags about the current health status of the field. Issues are being shown visually within the editor and a warning/error is triggered before adding the item to the cart.
Readonly restrictionsThe restrictions object holds flags about the restrictions configured against the field. Restrictions control what manipulations are possible within the editor UI.
The shadow object defines the field shadow settings. This is available for all field types except path fields.
Readonly typeThe type of the field
Readonly uioptionsThe UI options control the UI aviailable in the editor in relation to this field. Most of it will be used for the field specific dialog options.
Converts a relative field position (a position within the field from the top/left corner of the field without the rotation applied) to a global location on the canvas.
The point as the relative position.
The converted point as the global location.
Little helper to calculate the field bounding box - this includes also information about the location of all 4 corner points of the field on teh canvas.
The bounding box of the field. This is the area the field occupies on the canvas.
Rearranges the field on the canvas by adjusting the z-index in relation to the other fields. Updates the field properties.
The z-index change defined by the mode.
Save the changes of the script object back into the editor. This will update the field with the latest changes, but not every change will be reflected directly in the UI. Some changes would require reinitialization.
Note that not all properties can be saved with this function:
Saves the changes of the script back into the editor, while allowing to control certain actions via a save options object. For further information of what can be saved Save
The save options to use for this operation. If the parameter is a boolean, the value is used for the 'addUndo' flag of SaveOptions.
Generated using TypeDoc
A custom field allows to define a new field type via script.