Skip to main content

Option Surface

The Option Surface widget allows users to visualize data by displaying a 3D surface based on the Option Series data. This widget allows users to change Time to Maturity, select different Underlying dimensions, and individual Greeks and move up to the Implied Volatility rank of the VIX-like index of the option chain.

Features​

  • Multiple option metrics: 'volatility', 'delta', 'gamma', 'vega', 'theta', 'rho', 'theoPrice'.
  • Supports strike or delta for selected option metric.
  • Allows to view call or put side of option.
  • Different presentation of option expiration like date, tenor days, tenor years.
  • Integrated Symbol Search.

Showcases​

Selected symbol​

Main widget view with a selected symbol.

Widget with selected symbol

Unspecified symbol​

If no symbol is specified, the widget will display its initial state.

Widget without selected symbol

Dark mode​

By default, widgets support dark and light themes, though it's also possible to create a custom theme.

Widget in dark theme

Setup​

Installation​

The widget is distributed both via a CDN and as an NPM package.

npm i @dx-display/widgets-option-surface

CDN Link: https://path-to-cdn/widgets/option-surface.js

tip

Refer to this guide for instructions on utilizing our CDN bundle.

Configure DataProviders​

The Option Surface widget requires you to have access the following dxFeed Data Providers:

const dataProviders = {
  ipfPath: '/your-path/ipf',
  ipfAuthHeader: 'your-header',
  feedPath: 'wss://your-path/feed',
  feedAuthHeader: 'your-header',
  schedulePath: '/api/schedule',
}
Getting access

If you don't have access to these data providers, please contact dxFeed team.

Code example​

Below, you'll find a code example demonstrating widget integration, utilizing only the essential parameters. Refer to the widget API section for comprehensive details on all available options.

Show code!
import { newOptionSurfaceWidget } from '@dx-display/widgets-option-surface'

const dataProviders = {
  ipfPath: '/your-path/ipf',
  ipfAuthHeader: 'your-header',
  feedPath: 'wss://your-path/feed',
  feedAuthHeader: 'your-header',
  schedulePath: '/api/schedule',
}
// make sure that next element exist in your DOM
const container = document.getElementById('widget')
container.style.height = '600px'
container.style.width = '800px'

const widget = newOptionSurfaceWidget({
  element: container,
  providers: dataProviders,
})

Configurator​

API​

Please refer to the links below for a comprehensive list of all parameters available for the described widget.