Loading...
Searching...
No Matches
ATAS.Indicators.Modules Namespace Reference

Classes

interface  IPlatformModuleContext
 Read-only view of the panel (ATAS) or widget (ATAS X) a PlatformModule is shown in: the selected instrument and its latest market data, the size of the client area and the drawing resources of the platform theme. Available through PlatformModule.Context from PlatformModule.OnInitialize on. More...
 
interface  IPlatformModuleInstrument
 An instrument a PlatformModule asked for in addition to the one selected in its panel (IPlatformModuleContext.AddInstrument): what it is and the latest market data delivered to the module. More...
 
class  PlatformModule
 Base class of a custom module written in a custom assembly: a panel of the classic ATAS and a widget of ATAS X whose whole client area the module draws through RenderContext — one code base for both platforms. Derive from it, mark the class with PlatformModuleAttribute, give it a public parameterless constructor and override OnRender; the other hooks are optional. More...
 
class  PlatformModuleAttribute
 Marks a class derived from PlatformModule as a custom module and supplies its discovery metadata. The platform lists only modules that carry this attribute. More...
 
class  PlatformModuleButton
 A button a PlatformModule shows in the header of its panel, next to the standard buttons of the platform. Create it, set its properties and add it to IPlatformModuleContext.Buttons; the same code works in ATAS and ATAS X. Changing a property of a button that is in the list updates the header. More...
 
class  PlatformModuleIcons
 Ready-made icons for PlatformModuleButton.Icon: path geometry data in a 16×16 box. Any other data of the same form can be used instead.
 
class  PlatformModuleInstrumentInfo
 An instrument the platform knows, as IPlatformModuleContext.FindInstruments returns it: what to show to the user and the Id that names exactly this instrument for IPlatformModuleContext.AddInstrument. More...
 
class  PlatformModuleKeyEventArgs
 A key pressed or released while a PlatformModule has the keyboard focus. The same type is used in ATAS and ATAS X, so a module needs no WPF or Avalonia types. More...
 

Enumerations

enum  PlatformModuleInstrumentState {
  Connecting = 0 , Active = 1 , NoData = 2 , NotAllowed = 3 ,
  Removed = 4
}
 What the platform currently does with an additional instrument of a PlatformModule. More...
 
enum  PlatformModuleStandardButtons {
  None = 0 , InstrumentSelector = 1 , Settings = 2 , OnTop = 4 ,
  Clone = 8 , Layouts = 16
}
 The standard buttons of the panel header a PlatformModule may hide (IPlatformModuleContext.HiddenStandardButtons). The close button, the link group selector and — while the module has settings — the settings button cannot be hidden. The commands stay available in the context menu of the panel. More...
 

Enumeration Type Documentation

◆ PlatformModuleInstrumentState

What the platform currently does with an additional instrument of a PlatformModule.

Enumerator
Connecting 

Just added: the platform subscribes to the data on its next delivery pass.

Active 

Subscribed: the data of the instrument is delivered to the module as it arrives.

NoData 

The platform does not show live data of the instrument right now (no data permission, a market replay is running, or the subscription failed). Nothing is delivered; the platform retries by itself.

NotAllowed 

The tariff does not allow it (market data of other instruments for custom code, or the number of open instruments). Nothing is delivered; the platform retries by itself, so the data starts when the tariff allows it.

Removed 

The module removed the instrument, or the module instance was released.

◆ PlatformModuleStandardButtons

The standard buttons of the panel header a PlatformModule may hide (IPlatformModuleContext.HiddenStandardButtons). The close button, the link group selector and — while the module has settings — the settings button cannot be hidden. The commands stay available in the context menu of the panel.

Enumerator
None 

Nothing is hidden.

InstrumentSelector 

The instrument selector of the header (ATAS and ATAS X).

Settings 

The settings button (ATAS and ATAS X). Ignored while the module has settings: the user always reaches the settings window of a module that has something to set.

OnTop 

The "on top" pin of a floating panel (ATAS and ATAS X).

Clone 

The "clone" button (ATAS; ignored in ATAS X, whose header has none).

Layouts 

The "attach / detach layouts" button (ATAS; ignored in ATAS X, whose header has none).