SetFibonacciDescription

Sets the description text for a specific level of a Fibonacci object.

Syntax

SetFibonacciDescription(objectName: string, index: number, text: string): boolean

Parameters

• objectName: string - The name of the Fibonacci object

• index: number - The index of the Fibonacci level

• text: string - The description text to set

Return Value

Returns boolean - true if the description was set successfully.

Description

The SetFibonacciDescription method sets the description text for a specific level of a Fibonacci object. This method works with various Fibonacci tool types (retracements, fans, arcs, etc.) and allows customization of level labels.

Example

// Set description for a specific Fibonacci level
try {
  const success = this.api.SetFibonacciDescription(
    "MyFibo",
    2,
    "38.2% Retracement"
  );
  console.log(`Description set: ${success}`);
} catch (error) {
  console.log("Error:", error.message);
}

// Set descriptions for standard Fibonacci levels
const standardLevels = [
  { index: 0, value: "0.0%" },
  { index: 1, value: "23.6%" },
  { index: 2, value: "38.2%" },
  { index: 3, value: "50.0%" },
  { index: 4, value: "61.8%" },
  { index: 5, value: "78.6%" },
  { index: 6, value: "100.0%" },
  { index: 7, value: "161.8%" },
];

try {
  for (const level of standardLevels) {
    this.api.SetFibonacciDescription(
      "MyFibo",
      level.index,
      `Level ${level.value}`
    );
  }
} catch (error) {
  console.log("Error setting levels:", error.message);
}

// Example with custom formatting
try {
  const price = 1.2;
  this.api.SetFibonacciDescription("MyFibo", 0, `Support Level (${price})`);
} catch (error) {
  console.log("Error:", error.message);
}