Trader entry point.

Hierarchy

  • TraderEntry

Properties

Methods

Properties

lightningChart: ((opts?) => LightningChart)

Type declaration

    • (opts?): LightningChart
    • Create a new LightningChart JS instance.

      Parameters

      • Optional opts: Omit<LightningChartOptions, "license" | "licenseInformation">

        LightningChart JS options

      Returns LightningChart

      LightningChart JS instance

tradingChart: ((chartOptions?) => TradingChart)

Type declaration

    • (chartOptions?): TradingChart
    • Create a new trading chart instance.

      Parameters

      • Optional chartOptions: ChartOptions

        Optional chart options. Includes:

        -parentElement for setting parent HTML element for the chart.

        -loadFromStorage for allowing or blocking loading information from local storage.

        -axisOnRight for determining on which side the price axis (Y-axis) is located. Default side is right (true). Note that loading from local storage overrides this setting. Therefore, this option works only if loadFromStorage is set false.

        -colorTheme for setting the theme of the chart. Note that loading from local storage overrides this setting. Therefore, this option works only if loadFromStorage is set false.

        -canvas, an optional HTML-canvas element which LightningChart can use for rendering. Can be useful with complex layout settings.

        -lightningChart, an optional LightningChart instance that can be used to create charts. Can be useful with complex layout settings.

        -htmlTextRendering for controlling whether the chart uses html or WebGL for text rendering.

      Returns TradingChart

      Trading chart object.

Methods

  • Calculate the layout of all charts within this context again.

    This is used to inform charts that their position may have changed as a result of an Event that the charts are not aware of. For example, if the chart is positioned within a scrollable DIV.

     // Example syntax, trigger chart layout when it is scrolled.
    div.onscroll = () => c.layout()

    Returns void