General Object Entities

The Object section of the evCreate API includes type aliases, enumerations, interfaces, and functions to manage any type of item on the object level of the Envision document hierarchy.

`object` namespace

The Object evCreate API section is accessed with the object namespace:

evCreate.object.Function()

Type aliases

EvCoord2D: A type alias for an array of X and Y coordinates in 2D space.
EvFrameRef: A type alias for an internal identifier of an outline.
EvInkRef: A type alias for an internal identifier of a fill.
EvObjId: A type alias for an internal unique identifier of a 2D object.

Enumerations

EvFillType: An enumeration of the types of object item fills.
EvFlipDirection: An enumeration of object item axes options for flipping object items in the 2D document space.
EvObjectAlignment: An enumeration of options for aligning and distributing object items in the 2D document space on a page.
EvObjType: An enumeration of the types of object item objects.
EvOutlineCap: An enumeration of the types of line endpoints.
EvOutlineJoin: An enumeration of the types of outer corners (vertices) of object item outlines.
EvOutlinePlacement: An enumeration of the options for placing the object item outline along the object item bounding box.
EvOutlineType: An enumeration of the types of object item outlines.
EvPivotPoint: An enumeration of pivot points on bounding boxes of object items for rotating object items on a page.
EvRefPoint: An enumeration of reference points on bounding boxes of object items.
EvScaleType: An enumeration of units for scaling the sizes of object items on a page.
EvTransparencyArea: An enumeration of object item parts affected by transparency settings.
EvTrspBlendMode: An enumeration of the modes for blending foreground and background pixels when drawing transparent object items on a page.

Interfaces

EvColorFill: An interface that specifies the color of a fill.
EvFill: An interface that defines the fill of an object item.
EvHyperlink: An interface that defines a hyperlink attached to an object item.
EvLineOutline: An interface that specifies the attributes of an outline.
EvObjectAttributes: An interface that specifies the attributes of an object item.
EvObjectProperty: An interface that defines an additional custom property of an object item.
EvObjectReplicate: An interface that specifies the settings for replicating object items.
EvObjectZOrder: An interface that defines the layer of an object item and its position in the stack of object items on this layer.
EvOutline: An interface that defines the outline of an object item.
EvRect: An interface that describes a rectangular area in an Envision document.
EvSize2D: An interface that defines the width and height of an object.
EvTransparency: An interface that defines the transparency of an object item.

Functions

Delete(obj: EvItem): Promise<void>: A function to delete a given object item from the document.
Duplicate(objs: EvItem[], offsetX?: number, offsetY?: number): Promise<EvItem[]>: A function to create one copy of each given object item.
Flip(objs: EvItem[], direction: EvFlipDirection): Promise<void>: A function to flip given object items along their axes in the 2D document space.
GetAttributes(obj: EvItem, withTypeAttributes: boolean): Promise<EvObjectAttributes>: A function to get an object with the attributes of a given object item.
GetHyperlink(obj: EvItem): Promise<undefined | EvHyperlink>: A function to get an object with a hyperlink attached to a given object item.
GetPages(obj: EvItem): Promise<EvItem[]>: A function to get all the pages with a given object item.
GetPosition(obj: EvItem, transformed?: boolean, refPoint?: EvRefPoint): Promise<EvCoord2D>: A function to get the coordinates of a given object item in the 2D document space.
GetProperties(obj: EvItem): Promise<EvObjectProperty[]>: A function to get the custom properties of a given object item.
GetRotationAngle(obj: EvItem): Promise<number>: A function to get the rotation angle of a given object item in the 2D document space.
GetSize(obj: EvItem, transformed?: boolean): Promise<EvSize2D>: A function to get the 2D dimensions of a given object item.
GetZOrder(obj: EvItem): Promise<undefined | EvObjectZOrder>: A function to get the layer of an object item and its position in the stack of object items on this layer.
RemoveHyperlink(obj: EvItem): Promise<void>: A function to remove an attached hyperlink from a given object item.
RemoveProperty(obj: EvItem, propertyKey: string): Promise<void>: A function to remove a given custom property from a given object item.
RemoveTransform(objs: EvItem[]): Promise<void>: A function to remove transformations from given object items.
Render(objs: EvItem[], options?: EvRenderOptions): Promise<EvItem>: A function to render given object items into an image item object saved to the current page.
RenderTo(objs: EvItem[], options?: EvRenderOptions, format?: EvImageFormat): Promise<Uint8Array>: A function to render given object items into an image returned as binary data.
Replicate(objs: EvItem[], options?: EvObjectReplicate): Promise<EvItem[]>: A function to create one or more copies of given object items per given replication settings.
RotateTo(obj: EvItem, angle: number, pivot?: EvPivotPoint): Promise<void>: A function to rotate a given object item to a given angle around a given point on it.
SetAlignment(objs: EvItem[], alignment: EvObjectAlignment, boundingBox?: boolean): Promise<void>: A function to align or distribute given object items in the 2D document space on the page.
SetFill(obj: EvItem, fill: EvFill): Promise<void>: A function to manage the fill of a given object item.
SetHyperlink(obj: EvItem, link: EvHyperlink): Promise<void>: A function to create or update a hyperlink attached to a given object item.
SetLocked(obj: EvItem, isLocked: boolean): Promise<void>: A function to lock or unlock a given object item against editing.
SetName(obj: EvItem, name: string): Promise<void>: A function to rename a given object item.
SetOutline(obj: EvItem, outline: EvOutline): Promise<void>: A function to manage the outline of a given object item.
SetPosition(obj: EvItem, pos: EvCoord2D, transformed?: boolean, refPoint?: EvRefPoint): Promise<void>: A function to move a given object item to a new position in the 2D document space.
SetProperty(obj: EvItem, property: EvObjectProperty): Promise<void>: A function to create or update a custom property of a given object item.
SetSize(obj: EvItem, width: number, height: number, transformed?: boolean, refPoint?: EvRefPoint, lockAspect?: boolean, scaleOutline?: boolean): Promise<void>: A function to update the 2D dimensions of a given object item.
SetTransparency(obj: EvItem, percentage: number, mode?: EvTrspBlendMode, area?: EvTransparencyArea): Promise<void>: A function to manage the transparency of a given object item.
SetVisible(obj: EvItem, isVisible: boolean): Promise<void>: A function to hide or show a given object item on the layer.
SetZOrder(obj: EvItem, zOrder: EvObjectZOrder): Promise<void>: A function to move a given object item to a given stack position on a given layer.

23 April 2025