Class s7sdk.TargetDesc
The TargetDesc corresponds to the <targets> element of the req=set response and it represents zoom targets.
They can be private, associated with a particular asset, or they can be shared, associated with all images in the set. Shared targets apply
only to images that are defined at the same set level as the shared targets. That is, shared targets do not apply recursively
to the children of nested image sets.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
s7sdk.TargetDesc(index, frameId, rect, label, userdata)
|
| Field Attributes | Field Name and Description |
|---|---|
|
The
frameId specifies which image in the image set that the zoom target is located in. |
|
|
The numerical index value that identifies the zoom target.
|
|
|
Optional label associated with the target.
|
|
|
The zoom target rectangle in the top resolution coordinates.
|
|
|
Optional user data associated with the target.
|
Class Detail
s7sdk.TargetDesc(index, frameId, rect, label, userdata)
- Parameters:
- index
- The numerical index value that identifies the zoom target.
- frameId
- The frame in which the zoom target is located.
- rect
- The zoom target rectangle in the top resolution coordinates.
- label
- Optional label associated with the target.
- userdata
- Optional user data associated with the target.
- See:
- s7sdk.set.MediaSet
Field Detail
frameId
The
frameId specifies which image in the image set that the zoom target is located in.
For zoom targets returned in the req=set response, this information is implied. If explicitly set for shared targets,
the value is -1.
index
The numerical index value that identifies the zoom target.
label
Optional label associated with the target.
rect
The zoom target rectangle in the top resolution coordinates.
userdata
Optional user data associated with the target.