SetObjectEnumProperty

Sets an enumerated property value for a chart object.

Syntax

SetObjectEnumProperty(
    chartId: number,
    objectName: string,
    propId: ENUM_OBJECT_PROPERTY,
    propModifier: number,
    propValue: number
): void

Parameters

• chartId: number - The identifier of the chart

• objectName: string - The name of the object

• propId: ENUM_OBJECT_PROPERTY - The property identifier

• propModifier: number - Property modifier for indexed values

• propValue: number - The value to set

Return Value

This method does not return a value. It throws an error if the operation fails.

Description

The SetObjectEnumProperty method sets enumerated property values for a specified chart object. This method is specifically designed for working with enumerated properties like price points and Fibonacci levels.

Available properties (ENUM_OBJECT_PROPERTY):

• OBJECT_PROPERTY_PRICE: Price coordinate of a point

• OBJECT_PROPERTY_LEVEL_VALUE: Value of a Fibonacci level

Example

// Set price point of an object
this.api.SetObjectEnumProperty(
  1, // Chart ID
  "MyTrendLine",
  ENUM_OBJECT_PROPERTY.OBJECT_PROPERTY_PRICE,
  0, // First point
  1.2 // New price value
);

// Set Fibonacci level value
this.api.SetObjectEnumProperty(
  1,
  "MyFibo",
  ENUM_OBJECT_PROPERTY.OBJECT_PROPERTY_LEVEL_VALUE,
  2, // Third level
  0.618 // Fibonacci ratio
);

// Set multiple points for a triangle
const prices = [1.2, 1.21, 1.205];
for (let i = 0; i < 3; i++) {
  this.api.SetObjectEnumProperty(
    1,
    "MyTriangle",
    ENUM_OBJECT_PROPERTY.OBJECT_PROPERTY_PRICE,
    i,
    prices[i]
  );
}