SetObjectProperty

Sets a property value for a chart object.

Syntax

SetObjectProperty(
  name: string,
  index: number,
  value: any,
  isStatic: boolean = false
  ): boolean

Parameters

• name: string - The name of the object

• index: number - The property identifier

• value: any - The value to set

• isStatic: boolean - Optional. Whether the object is static (default: false)

Return Value

Returns boolean - true if the property was set successfully, false otherwise.

Description

The SetObjectProperty method sets a property value for a specified chart object. It can handle both numeric and string properties, and automatically converts time values from FTODate to the internal format.

Common properties that can be set are listed in the ObjProp documentation.

For TextAnnotatedPaintTool objects (H_LINE, V_LINE, RAY, RECTANGLE, TREND_LINE, SIGN, etc.): OBJPROP_TEXT sets the text content, OBJPROP_COLOR sets the font color, and OBJPROP_TEXT_PARAMS, OBJPROP_FONTSIZE, OBJPROP_FONTNAME sync with font styling. Use OBJPROP_VALIGNMENT and OBJPROP_HALIGNMENT for text alignment.

Example

// Set object coordinates
const success1 = this.api.SetObjectProperty(
  "MyTrendLine",
  ObjProp.OBJPROP_TIME1,
  this.api.createFTODate(1641024000000)
);
const success2 = this.api.SetObjectProperty(
  "MyTrendLine",
  ObjProp.OBJPROP_PRICE1,
  1.2
);

// Set visual properties
this.api.SetObjectProperty("MyTrendLine", ObjProp.OBJPROP_COLOR, 0xff0000); // Red color
this.api.SetObjectProperty("MyTrendLine", ObjProp.OBJPROP_STYLE, 1); // Solid line
this.api.SetObjectProperty("MyTrendLine", ObjProp.OBJPROP_WIDTH, 2); // Line width

// Set text properties
this.api.SetObjectProperty("MyLabel", ObjProp.OBJPROP_TEXT, "New Label Text");
this.api.SetObjectProperty("MyLabel", ObjProp.OBJPROP_FONTSIZE, 12);

// Set text alignment (TextAnnotatedPaintTool)
this.api.SetObjectProperty("MyLabel", ObjProp.OBJPROP_VALIGNMENT, TextVAlignment.vaCenter);
this.api.SetObjectProperty("MyLabel", ObjProp.OBJPROP_HALIGNMENT, TextHAlignment.haCenter);

// Set object state
this.api.SetObjectProperty("MyTrendLine", ObjProp.OBJPROP_HIDDEN, true);