Loading...
Searching...
No Matches
ATAS.Indicators.CandleSeriesRequest Class Reference

Describes a candle series to request: the timeframe and, optionally, another instrument. More...

Public Member Functions

override string ToString ()
 

Properties

CandleSeriesTimeFrame TimeFrame [get]
 The aggregation timeframe. Required unless ExoticTimeFrame is set.
 
ExoticCandleSeriesTimeFrameExoticTimeFrame [get]
 A parameter-heavy aggregation type (RangeX/RangeXV/RangeZ/RangeUS/ReversalX). When set, TimeFrame is ignored.
 
CandleSeriesInstrumentInstrument [get]
 The instrument; null or empty means the chart's instrument. A plain string (instrument code) converts implicitly.
 
int DaysToLoad = 5 [get]
 History depth in trading days. Clamped by the host (1..30) and by the tariff.
 
long? TradingSessionId [get]
 Trading session id (the same ids the chart's session selector uses, including custom sessions); null means the instrument's default session.
 

Detailed Description

Describes a candle series to request: the timeframe and, optionally, another instrument.

Member Function Documentation

◆ ToString()

override string ATAS.Indicators.CandleSeriesRequest.ToString ( )

Property Documentation

◆ DaysToLoad

int ATAS.Indicators.CandleSeriesRequest.DaysToLoad = 5
get

History depth in trading days. Clamped by the host (1..30) and by the tariff.

◆ ExoticTimeFrame

ExoticCandleSeriesTimeFrame? ATAS.Indicators.CandleSeriesRequest.ExoticTimeFrame
get

A parameter-heavy aggregation type (RangeX/RangeXV/RangeZ/RangeUS/ReversalX). When set, TimeFrame is ignored.

◆ Instrument

CandleSeriesInstrument? ATAS.Indicators.CandleSeriesRequest.Instrument
get

The instrument; null or empty means the chart's instrument. A plain string (instrument code) converts implicitly.

◆ TimeFrame

CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesRequest.TimeFrame
get

The aggregation timeframe. Required unless ExoticTimeFrame is set.

◆ TradingSessionId

long? ATAS.Indicators.CandleSeriesRequest.TradingSessionId
get

Trading session id (the same ids the chart's session selector uses, including custom sessions); null means the instrument's default session.


The documentation for this class was generated from the following file: