Cap.Definition
Summary
The method is used to create the Definition for a Cap.
Methods
Definition(instrumentCode: string )
Allows you to create a short definition for Cap.
Parameters:
| Name | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| instrumentCode | No | - | string | It is passed as parameter and will be used as instrumentCode from Cap.Params. |
Returned value: a Definition object
Definition(params: Cap.Params)
Allows you to create a full definition for Cap.
Cap.Params properties:
| Property | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| instrumentCode | No | - | string | - |
| discountingType | Yes | - | enum | See Cap.DiscountingType |
| surfaceLayout | Yes | - | Cap.Layout[] | See Cap.Layout bellow |
| surfaceTag | Yes | - | string | - |
| surfaceParameters | Yes | - | Cap.CalculationParams | See Cap.CalculationParams bellow |
| outputs | Yes | - | Output[] | See Cap.Output |
| extendedParams | Yes | - | {[key: string]: any} | Specifies the parameters that will be merged with the request |
Cap.Layout
| Property | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| format | No | - | enum | See Cap.LayoutFormat |
| dataPoints | Yes | - | LayoutDataPoint[] | See Cap.LayoutDataPoint bellow |
| xPointCount | Yes | - | number | - |
| xValues | Yes | - | string[] | - |
| yPointCount | Yes | - | number | - |
| yValues | Yes | - | string[] | - |
| zPointCount | Yes | - | number | - |
| zValues | Yes | - | string[] | - |
Cap.LayoutDataPoint
| Property | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| x | No | - | number | - |
| y | No | - | number | - |
Cap.CalculationParams
| Property | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| xAxis | No | - | enum | See Cap.AxisUnit |
| yAxis | No | - | enum | See Cap.AxisUnit |
| zAxis | Yes | - | enum | See Cap.AxisUnit |
| inputVolatilityType | Yes | - | enum | See Cap.InputVolatilityType |
| marketDataDate | Yes | - | string | - |
| shiftPercent | Yes | - | number | - |
| source | Yes | - | string | - |
| valuationDate | Yes | - | string | - |
| volatilityAdjustmentType | Yes | - | enum | See Cap.VolatilityAdjustmentType |
Returned value: a Definition object
getData(session: Session)
Sends a request to the data platform to retrieve the data described by the Definition object.
Parameters:
| Name | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| session | No | - | Session | Session instance |
Returned value: a ContentResponse
Learn more
For more information, please follow the link: https://developers.refinitiv.com/en/api-catalog/