defineSeriesInstrument
Ce contenu n’est pas encore disponible dans votre langue.
defineSeriesInstrument<
TLanguage>(def):object
Defined in: packages/runtime-core/lib/define.d.ts:28
Type Parameters
• TLanguage extends InstrumentLanguage
Parameters
def
Omit<{ __runtimeVersion: 1; clientDetails: ClientInstrumentDetails<TLanguage>; content: ScalarInstrumentInternal[]; details: InstrumentDetails<TLanguage>; id: string; internal: undefined; kind: "SERIES"; language: TLanguage; tags: InstrumentUIOption<TLanguage, string[]>; }, "__runtimeVersion">
Returns
object
__runtimeVersion
__runtimeVersion:
1
The runtime version for this instrument, which is set automatically by the defineInstrument function
clientDetails?
optionalclientDetails:ClientInstrumentDetails<TLanguage>
The content in the instrument to be rendered to the client
content
content:
ScalarInstrumentInternal[]
details
details:
InstrumentDetails<TLanguage>
The details of the instrument to be displayed to the user
id?
optionalid:string
The database ID for the instrument. For scalar instruments, this is derived by the internal property.
internal?
optionalinternal:undefined
kind
kind:
"SERIES"
language
language:
TLanguage
The language(s) in which the instrument is written
tags
tags:
InstrumentUIOption<TLanguage,string[]>
A list of tags that users can use to filter instruments