PriceTarget Generator

The PriceTarget generator displays analyst price target lines (high, mean, low) on the chart for a given instrument.

Add to Chart:

Use a Controller object to add the generator to a chart:

const priceTargetGenerator = controller.addGenerator('PriceTarget');
Copy

Types

type PriceTargetDataPoint = {
    startDate: number,
    endDate: number,
    mean: number,
    high: number,
    low: number
};

type PriceTargetFetcher = (params: { instrument: string, currency?: string }) => Promise<PriceTargetDataPoint[]>;
Copy

• startDate: timestamp marking the start of the price target period
• endDate: timestamp marking the end of the price target period
• mean: the average analyst price target
• high: the highest analyst price target
• low: the lowest analyst price target

Events:

The generator emits the following events:

#dataReady

• Type

  interface PriceTargetGenerator {
      emit(type: 'dataReady'): void;
  }
  Copy

• Details

  Emitted when price target data has been successfully loaded and applied to the chart.

#priceRatingInfoClicked

• Type

  interface PriceTargetGenerator {
      emit(type: 'priceRatingInfoClicked'): void;
  }
  Copy

• Details

  Emitted when the user clicks the "More info" button. Can be used to open a detailed view showing the price target and rating data.

Options:

The generator exposes several options to toggle which price target lines are displayed.

#h

• Type: boolean

• Default: false

• Details

  When enabled, the high price target line is displayed.

#l

• Type: boolean

• Default: false

• Details

  When enabled, the low price target line is displayed.

#m

• Type: boolean

• Default: true

• Details

  When enabled, the mean price target line is displayed.

Public methods:

The generator exposes several public methods.

#static setDataInterface

• Type

  declare class PriceTargetGenerator {
      static setDataInterface(priceTargetFetcher: PriceTargetFetcher): void
  }
  Copy

• Details

  setDataInterface adds the callback to the generator which is required for loading data.

  priceTargetFetcher is used to fetch price target data. The instrument and an optional currency will be passed to the function, which needs to return a PriceTargetDataPoint array.

• Example

  // example usage:
  PriceTargetGenerator.setDataInterface(async ({ instrument, currency }) => {
      const response = await fetch(`/api/pricetargets?instrument=${instrument}&currency=${currency}`);
      return response.json();
  });
  Copy

#setDataPoints

• Type

  interface PriceTargetGenerator {
      setDataPoints(dataPoints: PriceTargetDataPoint[]): void;
  }
  Copy

• Details

  setDataPoints takes a PriceTargetDataPoint array and adds those to the chart. May be used as a simple alternative to the setDataInterface method, though this requires manual calling when the instrument or currency of the chart changes.

• Example

  // example usage:
  priceTargetGenerator.setDataPoints([
      {
          startDate: 1700000000000,
          endDate: 1703000000000,
          mean: 150,
          high: 180,
          low: 120,
      },
  ]);
  Copy

Permissions

The generator has a built-in permission check, which is called in its onStart method. It calls the provided checkPermission method (via Controller) with the key PriceTarget.