Entity Data Types
These interfaces describe the data returned by createdEntityData and editedEntityData when the user creates or edits an entity in the display.
Each object carries a type discriminator (a Ve.EVisionElement value) so you can narrow the type before reading its properties.
IEntityData_Point2d
| Property | Type | Description |
|---|
x | number | X position in image coordinates |
y | number | Y position in image coordinates |
color | string | CSS color string |
opacity | number | Opacity from 0 to 1 |
marker | Ve.EMarkerType | Marker shape |
markerSize | number | Marker size in pixels |
IEntityData_Rect2d
| Property | Type | Description |
|---|
centerX | number | Center X in image coordinates |
centerY | number | Center Y in image coordinates |
width | number | Width in pixels |
height | number | Height in pixels |
angle | number | Rotation angle in degrees |
description | string | Optional text label |
lineWidth | number | Stroke width |
lineColor | string | CSS stroke color |
lineOpacity | number | Stroke opacity from 0 to 1 |
lineStyle | Ve.ELineStyle | Stroke dash style |
filled | boolean | Whether the shape is filled |
fillColor | string | CSS fill color |
fillOpacity | number | Fill opacity from 0 to 1 |
IEntityData_Segment2d
| Property | Type | Description |
|---|
x1 | number | Start X in image coordinates |
y1 | number | Start Y in image coordinates |
x2 | number | End X in image coordinates |
y2 | number | End Y in image coordinates |
lineWidth | number | Stroke width |
lineColor | string | CSS stroke color |
lineOpacity | number | Stroke opacity from 0 to 1 |
lineStyle | Ve.ELineStyle | Stroke dash style |
capSize1 | number | Size of the start cap |
cap1 | Ve.ECapType | Shape of the start cap |
capSize2 | number | Size of the end cap |
cap2 | Ve.ECapType | Shape of the end cap |
IEntityData_Line2d
| Property | Type | Description |
|---|
originX | number | Start X in image coordinates |
originY | number | Start Y in image coordinates |
endX | number | End X in image coordinates |
endY | number | End Y in image coordinates |
lineWidth | number | Stroke width |
lineColor | string | CSS stroke color |
lineOpacity | number | Stroke opacity from 0 to 1 |
lineStyle | Ve.ELineStyle | Stroke dash style |
IEntityData_Circle2d
| Property | Type | Description |
|---|
centerX | number | Center X in image coordinates |
centerY | number | Center Y in image coordinates |
radius | number | Radius in pixels |
lineWidth | number | Stroke width |
lineColor | string | CSS stroke color |
lineOpacity | number | Stroke opacity from 0 to 1 |
lineStyle | Ve.ELineStyle | Stroke dash style |
filled | boolean | Whether the shape is filled |
fillColor | string | CSS fill color |
fillOpacity | number | Fill opacity from 0 to 1 |
IEntityData_Ellipse2d
| Property | Type | Description |
|---|
centerX | number | Center X in image coordinates |
centerY | number | Center Y in image coordinates |
radiusA | number | Semi-major axis in pixels |
radiusB | number | Semi-minor axis in pixels |
angle | number | Rotation angle in degrees |
lineWidth | number | Stroke width |
lineColor | string | CSS stroke color |
lineOpacity | number | Stroke opacity from 0 to 1 |
lineStyle | Ve.ELineStyle | Stroke dash style |
filled | boolean | Whether the shape is filled |
fillColor | string | CSS fill color |
fillOpacity | number | Fill opacity from 0 to 1 |
IEntityData_Path2d
| Property | Type | Description |
|---|
points | { x: number; y: number }[] | Ordered list of path points in image coordinates |
closed | boolean | Whether the path is closed (last point connects to first) |
lineWidth | number | Stroke width |
lineColor | string | CSS stroke color |
lineOpacity | number | Stroke opacity from 0 to 1 |
lineStyle | Ve.ELineStyle | Stroke dash style |
filled | boolean | Whether the shape is filled |
fillColor | string | CSS fill color |
fillOpacity | number | Fill opacity from 0 to 1 |
IEntityData_Shape2d
| Property | Type | Description |
|---|
points | { x: number; y: number }[][] | Array of contours (outer boundary + holes) in image coordinates |
lineWidth | number | Stroke width |
lineColor | string | CSS stroke color |
lineOpacity | number | Stroke opacity from 0 to 1 |
lineStyle | Ve.ELineStyle | Stroke dash style |
filled | boolean | Whether the shape is filled |
fillColor | string | CSS fill color |
fillOpacity | number | Fill opacity from 0 to 1 |
IEntityData_AnchorString
Text anchored to a single point in image coordinates.
| Property | Type | Description |
|---|
value | string | The text content |
color | string | CSS text color |
opacity | number | Opacity from 0 to 1 |
fontSize | number | Font size in pixels |
originX | number | Anchor X in image coordinates |
originY | number | Anchor Y in image coordinates |
angle | number | Rotation angle in degrees |
hAlignment | "LEFT" \| "CENTER" \| "RIGHT" | Horizontal alignment relative to anchor |
vAlignment | "TOP" \| "CENTER" \| "BOTTOM" | Vertical alignment relative to anchor |
IEntityData_FrameString
Text fitted inside a rectangular frame in image coordinates.
| Property | Type | Description |
|---|
value | string | The text content |
color | string | CSS text color |
opacity | number | Opacity from 0 to 1 |
fontSize | number | Font size in pixels |
frameWidth | number | Frame width in pixels |
frameHeight | number | Frame height in pixels |
frameCenterX | number | Frame center X in image coordinates |
frameCenterY | number | Frame center Y in image coordinates |
hAlignment | "LEFT" \| "CENTER" \| "RIGHT" | Horizontal alignment within the frame |
vAlignment | "TOP" \| "CENTER" \| "BOTTOM" | Vertical alignment within the frame |