PriceTarget Generator

Add to Chart:

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

const newsGenerator = 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

Public methods:

The generator exposes several public methods.

#static setDataInterface

• Type

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

• Details

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

  priceTargetFetch 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.

#addArticles

• Type

  interface NewsGenerator {
      setDataPoints(articles: ArticleData[]): void;
  }
  Copy

• Details

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

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.