FindArrayMaximum

Description

The FindArrayMaximum method finds the index of the maximum value in a numeric array within a specified range.

Syntax

public FindArrayMaximum(
    array: number[],
    count: number = APIConstants.ARRAY_ENTIRE,
    start = 0
    ): number

Parameters

• array: An array of numbers to search in

• count: Optional. The number of elements to search through. Default is ARRAY_ENTIRE

• start: Optional. The starting index for the search. Default is 0

Return Value

Returns a number representing the index of the maximum value in the specified range. Returns -1 if the range is invalid.

Example

const prices = [10.5, 11.2, 10.8, 11.5, 10.9];
const maxIndex = this.api.FindArrayMaximum(prices);
console.log(`Maximum price ${prices[maxIndex]} found at index ${maxIndex}`);

// Search in a specific range
const rangeMaxIndex = this.api.FindArrayMaximum(prices, 3, 1); // Search 3 elements starting from index 1