segmentIndex property

num get segmentIndex

Gets or sets the segment index of a GraphObject that is in a Link. Non-negative numbers count up from zero, which is the first segment, at the "from" end of the Link. Negative numbers count segments from the "to" end of the Link, where -1 means the last segment and -2 means the next-to-last segment. The default value is -Infinity. The value should be an integer or NaN.

Setting this value to NaN means #segmentFraction's fractional distance will be calculated along the entire link route. A NaN value also means the Link#midPoint and Link#midAngle will not be used when determining label positions.

If you do not set this property, the Link will choose a place that is approximately at the mid-point of the link's route.

For examples of how to use this property, see Link Labels.

Implementation

_i2.num get segmentIndex => _i4.getProperty(
      this,
      'segmentIndex',
    );

set segmentIndex (num value)

Implementation

set segmentIndex(_i2.num value) {
  _i4.setProperty(
    this,
    'segmentIndex',
    value,
  );
}