GetObjectEnumProperty

Retrieves an enumerated property value from a chart object.

Syntax

GetObjectEnumProperty(
    chartId: number,
    objectName: string,
    propId: ENUM_OBJECT_PROPERTY,
    propModifier: number = 0
): number

Parameters

• chartId: number - The identifier of the chart

• objectName: string - The name of the object

• propId: ENUM_OBJECT_PROPERTY - The property identifier

• propModifier: number - Optional. Property modifier for indexed values (default: 0)

Return Value

Returns a number representing the property value.

Description

The GetObjectEnumProperty method retrieves enumerated property values from 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

// Get price point of an object
const price = this.api.GetObjectEnumProperty(
  1, // Chart ID
  "MyTrendLine",
  ENUM_OBJECT_PROPERTY.OBJECT_PROPERTY_PRICE,
  0 // First point
);
console.log(`First point price: ${price}`);

// Get Fibonacci level value
const levelValue = this.api.GetObjectEnumProperty(
  1,
  "MyFibo",
  ENUM_OBJECT_PROPERTY.OBJECT_PROPERTY_LEVEL_VALUE,
  2 // Third level
);
console.log(`Fibonacci level 2 value: ${levelValue}`);

// Get multiple points
for (let i = 0; i < 3; i++) {
  const pointPrice = this.api.GetObjectEnumProperty(
    1,
    "MyTriangle",
    ENUM_OBJECT_PROPERTY.OBJECT_PROPERTY_PRICE,
    i
  );
  console.log(`Point ${i} price: ${pointPrice}`);
}