Class ChordProgressionChord

ChordProgressionChord represents a chord to be played within a progression, specifying the start and end time of the chord.

Hierarchy

  • Range

    Hierarchy

    • ChordProgressionChord

Constructors

constructor

Accessors

chord duration end start typeName

Methods

contains getPercent

Constructors

constructor

Accessors

chord

  • get chord(): Chord

  • The chord to be played at a specific point in the progression.

    Returns Chord

  • set chord(value: Chord): void

  • Parameters

    Returns void

duration

  • get duration(): number

  • The difference between the start and end values.

    Attempts to set this to a negative value will result in an error being thrown.

    Returns number

  • set duration(value: number): void

  • Parameters

    • value: number

    Returns void

end

  • get end(): number

  • The value which the range ends at.

    Attempts to set this to a value less than start will result in an error being thrown.

    Returns number

  • set end(value: number): void

  • Parameters

    • value: number

    Returns void

start

  • get start(): number

  • The value which the range starts at.

    Attempts to set this to a value greater than end will result in an error being thrown.

    Returns number

  • set start(value: number): void

  • Parameters

    • value: number

    Returns void

typeName

  • get typeName(): string

  • Returns the name of this type. This can be used rather than instanceof which is sometimes unreliable.

    Returns string

Methods

contains

  • Returns true if the passed in point is greater than or equal to range start, and less than or equal to range end.

    Returns

    Parameters

    • point: number

      The point value to determine whether it's within the range.

    Returns boolean

getPercent

  • Accepts a value and returns what percentage of the way into the range that the value is.

    The returned value can be negative, or greater than 100%, if the passed in value is less than the range start, or greater than the range end.

    Returns

    Parameters

    • value: number

      The value to compare against the range.

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc