VS:GetGradientSpotPosition
Jump to navigation
Jump to search
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Gets the spot position of the specified gradient segment.
PROCEDURE GetGradientSpotPosition(
gradient :HANDLE;
segmentIndex :INTEGER;
VAR position :REAL);
def vs.GetGradientSpotPosition(gradient, segmentIndex): return position
Parameters
gradient HANDLE Gradient that contains the segment. segmentIndex INTEGER Segment from which to get the data. position REAL Position of the segment's color spot relative to left-most point of the gradient.
Example
VectorScript
GetGradientSpotPosition(gradientHandle, 4, spotPosition);
Python
spotPosition = vs.GetGradientSpotPosition(gradientHandle, 4)
Version
Availability: from VectorWorks10.0