Class ColorRamp

Readonly[unscopables]

length

Static Readonly[species]

[iterator]

• "[iterator]"(): ArrayIterator<ColorStop>

  Iterator

  Returns ArrayIterator<ColorStop>

concat

• concat(...items: ConcatArray<ColorStop>[]): ColorStop[]

  Combines two or more arrays. This method returns a new array without modifying any existing arrays.

  Parameters

  • ...items: ConcatArray<ColorStop>[]

    Additional arrays and/or items to add to the end of the array.

  Returns ColorStop[]

• concat(...items: (ColorStop | ConcatArray<ColorStop>)[]): ColorStop[]

  Combines two or more arrays. This method returns a new array without modifying any existing arrays.

  Parameters

  • ...items: (ColorStop | ConcatArray<ColorStop>)[]

    Additional arrays and/or items to add to the end of the array.

  Returns ColorStop[]

copyWithin

• copyWithin(target: number, start: number, end?: number): this

  Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

  Parameters

  • target: number

    If target is negative, it is treated as length+target where length is the length of the array.

  • start: number

    If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

  • Optionalend: number

    If not specified, length of the this object is used as its default value.

  Returns this

entries

• entries(): ArrayIterator<[number, ColorStop]>

  Returns an iterable of key, value pairs for every entry in the array

  Returns ArrayIterator<[number, ColorStop]>

every

• every<S extends ColorStop>(
      predicate: (
          value: ColorStop,
          index: number,
          array: ColorStop[],
      ) => value is S,
      thisArg?: any,
  ): this is S[]

  Determines whether all the members of an array satisfy the specified test.

  Type Parameters

  • S extends ColorStop

  Parameters

  • predicate: (value: ColorStop, index: number, array: ColorStop[]) => value is S

    A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns this is S[]

• every(
      predicate: (
          value: ColorStop,
          index: number,
          array: ColorStop[],
      ) => unknown,
      thisArg?: any,
  ): boolean

  Determines whether all the members of an array satisfy the specified test.

  Parameters

  • predicate: (value: ColorStop, index: number, array: ColorStop[]) => unknown

    A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns boolean

fill

• fill(value: ColorStop, start?: number, end?: number): this

  Changes all array elements from start to end index to a static value and returns the modified array

  Parameters

  • value: ColorStop

    value to fill array section with

  • Optionalstart: number

    index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

  • Optionalend: number

    index to stop filling the array at. If end is negative, it is treated as length+end.

  Returns this

filter

• filter<S extends ColorStop>(
      predicate: (
          value: ColorStop,
          index: number,
          array: ColorStop[],
      ) => value is S,
      thisArg?: any,
  ): S[]

  Returns the elements of an array that meet the condition specified in a callback function.

  Type Parameters

  • S extends ColorStop

  Parameters

  • predicate: (value: ColorStop, index: number, array: ColorStop[]) => value is S

    A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns S[]

• filter(
      predicate: (
          value: ColorStop,
          index: number,
          array: ColorStop[],
      ) => unknown,
      thisArg?: any,
  ): ColorStop[]

  Returns the elements of an array that meet the condition specified in a callback function.

  Parameters

  • predicate: (value: ColorStop, index: number, array: ColorStop[]) => unknown

    A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns ColorStop[]

find

• find<S extends ColorStop>(
      predicate: (
          value: ColorStop,
          index: number,
          obj: ColorStop[],
      ) => value is S,
      thisArg?: any,
  ): S | undefined

  Returns the value of the first element in the array where predicate is true, and undefined otherwise.

  Type Parameters

  • S extends ColorStop

  Parameters

  • predicate: (value: ColorStop, index: number, obj: ColorStop[]) => value is S

    find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

  Returns S | undefined

• find(
      predicate: (
          value: ColorStop,
          index: number,
          obj: ColorStop[],
      ) => unknown,
      thisArg?: any,
  ): ColorStop | undefined

  Parameters

  • predicate: (value: ColorStop, index: number, obj: ColorStop[]) => unknown
  • OptionalthisArg: any

  Returns ColorStop | undefined

findIndex

• findIndex(
      predicate: (
          value: ColorStop,
          index: number,
          obj: ColorStop[],
      ) => unknown,
      thisArg?: any,
  ): number

  Returns the index of the first element in the array where predicate is true, and -1 otherwise.

  Parameters

  • predicate: (value: ColorStop, index: number, obj: ColorStop[]) => unknown

    find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

  • OptionalthisArg: any

    If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

  Returns number

flat

• flat<A, D extends number = 1>(this: A, depth?: D): FlatArray<A, D>[]

  Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

  Type Parameters

  • A
  • D extends number = 1

  Parameters

  • this: A
  • Optionaldepth: D

    The maximum recursion depth

  Returns FlatArray<A, D>[]

flatMap

• flatMap<U, This = undefined>(
      callback: (
          this: This,
          value: ColorStop,
          index: number,
          array: ColorStop[],
      ) => U | readonly U[],
      thisArg?: This,
  ): U[]

  Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

  Type Parameters

  • U
  • This = undefined

  Parameters

  • callback: (
        this: This,
        value: ColorStop,
        index: number,
        array: ColorStop[],
    ) => U | readonly U[]

    A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

  • OptionalthisArg: This

    An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

  Returns U[]

forEach

• forEach(
      callbackfn: (
          value: ColorStop,
          index: number,
          array: ColorStop[],
      ) => void,
      thisArg?: any,
  ): void

  Performs the specified action for each element in an array.

  Parameters

  • callbackfn: (value: ColorStop, index: number, array: ColorStop[]) => void

    A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

  • OptionalthisArg: any

    An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

  Returns void

includes

• includes(searchElement: ColorStop, fromIndex?: number): boolean

  Determines whether an array includes a certain element, returning true or false as appropriate.

  Parameters

  • searchElement: ColorStop

    The element to search for.

  • OptionalfromIndex: number

    The position in this array at which to begin searching for searchElement.

  Returns boolean

indexOf

• indexOf(searchElement: ColorStop, fromIndex?: number): number

  Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

  Parameters

  • searchElement: ColorStop

    The value to locate in the array.

  • OptionalfromIndex: number

    The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

  Returns number

join

• join(separator?: string): string

  Adds all the elements of an array into a string, separated by the specified separator string.

  Parameters

  • Optionalseparator: string

    A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

  Returns string

keys

• keys(): ArrayIterator<number>

  Returns an iterable of keys in the array

  Returns ArrayIterator<number>

lastIndexOf

• lastIndexOf(searchElement: ColorStop, fromIndex?: number): number

  Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

  Parameters

  • searchElement: ColorStop

    The value to locate in the array.

  • OptionalfromIndex: number

    The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

  Returns number

map

• map<U>(
      callbackfn: (value: ColorStop, index: number, array: ColorStop[]) => U,
      thisArg?: any,
  ): U[]

  Calls a defined callback function on each element of an array, and returns an array that contains the results.

  Type Parameters

  • U

  Parameters

  • callbackfn: (value: ColorStop, index: number, array: ColorStop[]) => U

    A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

  • OptionalthisArg: any

    An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

  Returns U[]

pop

• pop(): ColorStop | undefined

  Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

  Returns ColorStop | undefined

push

• push(...items: ColorStop[]): number

  Appends new elements to the end of an array, and returns the new length of the array.

  Parameters

  • ...items: ColorStop[]

    New elements to add to the array.

  Returns number

reduce

• reduce(
      callbackfn: (
          previousValue: ColorStop,
          currentValue: ColorStop,
          currentIndex: number,
          array: ColorStop[],
      ) => ColorStop,
  ): ColorStop

  Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Parameters

  • callbackfn: (
        previousValue: ColorStop,
        currentValue: ColorStop,
        currentIndex: number,
        array: ColorStop[],
    ) => ColorStop

    A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

  Returns ColorStop

• reduce(
      callbackfn: (
          previousValue: ColorStop,
          currentValue: ColorStop,
          currentIndex: number,
          array: ColorStop[],
      ) => ColorStop,
      initialValue: ColorStop,
  ): ColorStop

  Parameters

  • callbackfn: (
        previousValue: ColorStop,
        currentValue: ColorStop,
        currentIndex: number,
        array: ColorStop[],
    ) => ColorStop
  • initialValue: ColorStop

  Returns ColorStop

• reduce<U>(
      callbackfn: (
          previousValue: U,
          currentValue: ColorStop,
          currentIndex: number,
          array: ColorStop[],
      ) => U,
      initialValue: U,
  ): U

  Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Type Parameters

  • U

  Parameters

  • callbackfn: (
        previousValue: U,
        currentValue: ColorStop,
        currentIndex: number,
        array: ColorStop[],
    ) => U

    A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

  • initialValue: U

    If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

  Returns U

reduceRight

• reduceRight(
      callbackfn: (
          previousValue: ColorStop,
          currentValue: ColorStop,
          currentIndex: number,
          array: ColorStop[],
      ) => ColorStop,
  ): ColorStop

  Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Parameters

  • callbackfn: (
        previousValue: ColorStop,
        currentValue: ColorStop,
        currentIndex: number,
        array: ColorStop[],
    ) => ColorStop

    A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

  Returns ColorStop

• reduceRight(
      callbackfn: (
          previousValue: ColorStop,
          currentValue: ColorStop,
          currentIndex: number,
          array: ColorStop[],
      ) => ColorStop,
      initialValue: ColorStop,
  ): ColorStop

  Parameters

  • callbackfn: (
        previousValue: ColorStop,
        currentValue: ColorStop,
        currentIndex: number,
        array: ColorStop[],
    ) => ColorStop
  • initialValue: ColorStop

  Returns ColorStop

• reduceRight<U>(
      callbackfn: (
          previousValue: U,
          currentValue: ColorStop,
          currentIndex: number,
          array: ColorStop[],
      ) => U,
      initialValue: U,
  ): U

  Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Type Parameters

  • U

  Parameters

  • callbackfn: (
        previousValue: U,
        currentValue: ColorStop,
        currentIndex: number,
        array: ColorStop[],
    ) => U

    A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

  • initialValue: U

    If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

  Returns U

shift

• shift(): ColorStop | undefined

  Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

  Returns ColorStop | undefined

slice

• slice(start?: number, end?: number): ColorStop[]

  Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

  Parameters

  • Optionalstart: number

    The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

  • Optionalend: number

    The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

  Returns ColorStop[]

some

• some(
      predicate: (
          value: ColorStop,
          index: number,
          array: ColorStop[],
      ) => unknown,
      thisArg?: any,
  ): boolean

  Determines whether the specified callback function returns true for any element of an array.

  Parameters

  • predicate: (value: ColorStop, index: number, array: ColorStop[]) => unknown

    A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns boolean

sort

• sort(compareFn?: (a: ColorStop, b: ColorStop) => number): this

  Sorts an array in place. This method mutates the array and returns a reference to the same array.

  Parameters

  • OptionalcompareFn: (a: ColorStop, b: ColorStop) => number

    Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.

    [11,2,22,1].sort((a, b) => a - b)
    

  Returns this

splice

• splice(start: number, deleteCount?: number): ColorStop[]

  Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

  Parameters

  • start: number

    The zero-based location in the array from which to start removing elements.

  • OptionaldeleteCount: number

    The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

  Returns ColorStop[]

  An array containing the elements that were deleted.

• splice(start: number, deleteCount: number, ...items: ColorStop[]): ColorStop[]

  Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

  Parameters

  • start: number

    The zero-based location in the array from which to start removing elements.

  • deleteCount: number

    The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

  • ...items: ColorStop[]

    Elements to insert into the array in place of the deleted elements.

  Returns ColorStop[]

  An array containing the elements that were deleted.

toLocaleString

• toLocaleString(): string

  Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

  Returns string

• toLocaleString(
      locales: string | string[],
      options?: NumberFormatOptions & DateTimeFormatOptions,
  ): string

  Parameters

  • locales: string | string[]
  • Optionaloptions: NumberFormatOptions & DateTimeFormatOptions

  Returns string

toString

• toString(): string

  Returns a string representation of an array.

  Returns string

unshift

• unshift(...items: ColorStop[]): number

  Inserts new elements at the start of an array, and returns the new length of the array.

  Parameters

  • ...items: ColorStop[]

    Elements to insert at the start of the array.

  Returns number

values

• values(): ArrayIterator<ColorStop>

  Returns an iterable of values in the array

  Returns ArrayIterator<ColorStop>

Staticfrom

• from<T>(arrayLike: ArrayLike<T>): T[]

  Creates an array from an array-like object.

  Type Parameters

  • T

  Parameters

  • arrayLike: ArrayLike<T>

    An array-like object to convert to an array.

  Returns T[]

• from<T, U>(
      arrayLike: ArrayLike<T>,
      mapfn: (v: T, k: number) => U,
      thisArg?: any,
  ): U[]

  Creates an array from an iterable object.

  Type Parameters

  • T
  • U

  Parameters

  • arrayLike: ArrayLike<T>

    An array-like object to convert to an array.

  • mapfn: (v: T, k: number) => U

    A mapping function to call on every element of the array.

  • OptionalthisArg: any

    Value of 'this' used to invoke the mapfn.

  Returns U[]

• from<T>(iterable: Iterable<T, any, any> | ArrayLike<T>): T[]

  Creates an array from an iterable object.

  Type Parameters

  • T

  Parameters

  • iterable: Iterable<T, any, any> | ArrayLike<T>

    An iterable object to convert to an array.

  Returns T[]

• from<T, U>(
      iterable: Iterable<T, any, any> | ArrayLike<T>,
      mapfn: (v: T, k: number) => U,
      thisArg?: any,
  ): U[]

  Creates an array from an iterable object.

  Type Parameters

  • T
  • U

  Parameters

  • iterable: Iterable<T, any, any> | ArrayLike<T>

    An iterable object to convert to an array.

  • mapfn: (v: T, k: number) => U

    A mapping function to call on every element of the array.

  • OptionalthisArg: any

    Value of 'this' used to invoke the mapfn.

  Returns U[]

StaticisArray

• isArray(arg: any): arg is any[]

  Parameters

  • arg: any

  Returns arg is any[]

Staticof

• of<T>(...items: T[]): T[]

  Returns a new array from a set of elements.

  Type Parameters

  • T

  Parameters

  • ...items: T[]

    A set of elements to include in the new array object.

  Returns T[]