BorderLine

This class can be used to easily model an orthogonal borderline or sky-line.

Inheritance Hierarchy

BorderLine

Remarks

It provides methods for measuring the distance between different BorderLine instances, merging multiple instances, modifying, and efficiently moving them around.

Type Details

yFiles module: algorithms

Constructors

BorderLine

(value: number)

Initializes a new instance of the BorderLine class, representing a single segment that extends from the lowest possible position (-Number.MAX_VALUE) to the highest possible position (+ Number.MAX_VALUE) with a constant value.

Parameters

options - Object
A map of options to pass to the method.

value - number: the value of the segment

BorderLine

(min: number, max: number, value: number)

Initializes a new instance of the BorderLine class, representing a single segment that extends from the specified min position to the specified max position with a constant value.

Parameters

options - Object
A map of options to pass to the method.

min - number: The starting position of the BorderLine
max - number: The ending position of the BorderLine
value - number: The value of the segment

BorderLine

(min: number, max: number, valueAtMin: number, valueAtMax: number)

Initializes a new instance of the BorderLine class, representing a single segment that extends from the specified min position to the specified max position.

Parameters

options - Object
A map of options to pass to the method.

min - number: The starting position of the BorderLine
max - number: The ending position of the BorderLine
valueAtMin - number: The value at the starting position of the segment
valueAtMax - number: The value at the ending position of the segment

Properties

firstSegment

: BorderLineSegment?

Returns the first segment or null if there is no such segment.

lastSegment

: BorderLineSegment?

Returns the last segment or null if there is no such segment.

maxPosition

: number

Gets the highest position of this border line

maxValue

: number

Gets the highest value that is set on this borderline

Property Value

the value

minPosition

: number

Gets the lowest position of this borderline

minValue

: number

Gets the lowest value that is set on this borderline

Property Value

the value

Methods

addPositionOffset

(delta: number)

Adds the given offset to the segments' positions.

Remarks

This method has complexity O(1).

Parameters

options - Object
A map of options to pass to the method.

delta - number: the delta to add to the positions

addValueOffset

(delta: number)

Adds the given offset to the current values of the whole borderline.

Remarks

This method has complexity O(1).

Parameters

options - Object
A map of options to pass to the method.

delta - number: The delta to add to the values

createCopy

(negateValues?: boolean, negateOffsets?: boolean) : BorderLine

Creates a copy of this borderline, optionally negating the values or offsets

ParametersOptions Overload

options - Object
A map of options to pass to the method.

negateValues - boolean: whether the values are negated
negateOffsets - boolean: whether the offsets are negated

Returns

↪BorderLine: the copy of the borderline

createMaximum

(other: BorderLine) : BorderLine

Merges this borderline with the given borderline using the "maximum" policy.

Remarks

That means the resulting borderline will have a greater value of both borderlines on each position. If you imagine each borderline as the upper border of a plane, the resulting borderline will be the upper border of the merged planes.

Parameters

options - Object
A map of options to pass to the method.

other - BorderLine: the other borderline

Returns

↪BorderLine: a new borderline that is the result of the merge

createMinimum

(other: BorderLine) : BorderLine

Merges this borderline with the given borderline using the "minimum" policy.

Remarks

That means the resulting borderline will have a smaller value of both borderlines on each position. If you imagine each borderline as the lower border of a plane, the resulting borderline will be the lower border of the merged planes.

Parameters

options - Object
A map of options to pass to the method.

other - BorderLine: the other borderline

Returns

↪BorderLine: a new borderline that is the result of the merge

enlarge

(toMin: number, toMax: number, positive: boolean)

Enlarges this borderline horizontally, so that the values of the borderline stay the same however their starting and ending positions are moved in the direction of toMin and toMax.

Remarks

This is useful for scenarios where a borderline is needed that consists of an enlarged border.

Note that this method normalizes the segments, i.e., it transforms each segment with slope != 0 to a segment with slope == 0.

Parameters

options - Object
A map of options to pass to the method.

toMin - number: the delta by which the border should be extended towards -Infinity
toMax - number: the delta by which the border should be extended towards +Infinity
positive - boolean: whether the borderline should be interpreted to point in positive direction. This influences the direction into which a segment's border is extended.

getDistanceTo

(greater: BorderLine) : number

Calculates the minimum distance between this borderline and the other one.

Remarks

The other one is treated as if the values were all greater.

Parameters

options - Object
A map of options to pass to the method.

greater - BorderLine: The other borderline to which the distance is calculated.

Returns

↪number: The minimum distance between this borderline and the other one.

getMax

(segment: BorderLineSegment) : number

Returns the highest position of the given segment.

Parameters

options - Object
A map of options to pass to the method.

segment - BorderLineSegment: The segment

Returns

↪number: The highest position of the given segment.

getMaxValue

(from: number, to: number) : number

Calculates the maximum value in the interval specified by position from and position to.

Parameters

options - Object
A map of options to pass to the method.

from - number: The starting position of the interval.
to - number: The ending position of the interval.

Returns

↪number: The maximum value in the interval specified by position from and position to.

If the from value is larger or equal to the to value, the algorithm always returns -Number.MAX_VALUE.

getMinPosition

(segment: BorderLineSegment) : number

Returns the lowest position of the given segment.

Parameters

options - Object
A map of options to pass to the method.

segment - BorderLineSegment: The segment

Returns

↪number: The lowest position of the given segment.

getMinValue

(from: number, to: number) : number

Calculates the minimum value in the interval specified by position from and position to.

Parameters

options - Object
A map of options to pass to the method.

from - number: The starting position of the interval.
to - number: The ending position of the interval.

Returns

↪number: The minimum value in the interval specified by position from and position to.

If the from value is larger or equal to the to value, the algorithm always returns Number.MAX_VALUE.

getSegmentAt

(position: number) : BorderLineSegment

Returns the segment at the given position.

Parameters

options - Object
A map of options to pass to the method.

position - number: The position

Returns

↪BorderLineSegment?: The segment at the given position.

getSlope

(segment: BorderLineSegment) : number

Returns the slope of the given segment.

Parameters

options - Object
A map of options to pass to the method.

segment - BorderLineSegment: The segment

Returns

↪number: The slope of the given segment.

getValue

(segment: BorderLineSegment) : number

Returns the value at the lowest position of the given segment.

Remarks

If the segment's slope is 0, it is the value of the whole segment. In case the slope differs from 0, it is the value of the start of the slope.

Parameters

options - Object
A map of options to pass to the method.

segment - BorderLineSegment: The segment

Returns

↪number: The value at the lowest position of the given segment.

getValueAt

(position: number) : number

Returns the value that is set on this borderline at the specified position.

Parameters

options - Object
A map of options to pass to the method.

position - number: The position for which the value is to be returned

Returns

↪number: The value

Throws

Exception({ name: 'IndexOutOfRangeError' }): If the position is outside the borderline.

getValueAt

(segment: BorderLineSegment, position: number) : number

Returns the value that is set on this borderline at the specified position.

Remarks

The position must lie within the range of the segment.

Parameters

options - Object
A map of options to pass to the method.

segment - BorderLineSegment: The segment for which the value is to be returned
position - number: The position for which the value is to be returned

Returns

↪number: The value

Throws

Exception({ name: 'ArgumentError' }): if position is outside the segment's range.

mergeWithMax

(other: BorderLine)

Merges this borderline with the given borderline using the "maximum" policy.

Parameters

options - Object
A map of options to pass to the method.

other - BorderLine: the other borderline

mergeWithMin

(other: BorderLine)

Merges this borderline with the given borderline using the "minimum" policy.

Parameters

options - Object
A map of options to pass to the method.

other - BorderLine: the other borderline

setMaxValue

(min: number, max: number, value: number)

Assures that all values in the given interval are greater than or equal to the given value.

Parameters

options - Object
A map of options to pass to the method.

min - number: the lower position of the interval
max - number: the upper position of the interval
value - number: the smallest possible value for the interval

setMinValue

(min: number, max: number, value: number)

Assures that all values in the given interval are less than or equal to the given value.

Parameters

options - Object
A map of options to pass to the method.

min - number: the lower position of the interval
max - number: the upper position of the interval
value - number: the greatest possible value for the interval

setSloped

(min: number, max: number, value: number, slope: number)

Sets a specific interval specified by position min and position max to a slope starting at a given value.

Parameters

options - Object
A map of options to pass to the method.

min - number: The lower position of the interval.
max - number: The upper position of the interval.
value - number: The value at min where the slope starts.
slope - number: The slope of the segment in the given interval.

Throws

Exception({ name: 'ArgumentError' }): If min is greater than max.

setValue

(min: number, max: number, value: number)

Sets a specific interval specified by position min and position max to a given value.

Parameters

options - Object
A map of options to pass to the method.

min - number: The lower position of the interval.
max - number: The upper position of the interval.
value - number: The value for the whole interval.

toString

() : string

Returns a lengthy string representation of this borderline.

Returns

↪string: A lengthy string representation of this borderline.