newEarningsCalendarWidget

newEarningsCalendarWidget is a constructor function for creating the Earnings Calendar widget.

Widget Constructor

Call newEarningsCalendarWidget to create a widget instance inside a browser DOM element.

import { newEarningsCalendarWidget } from '@dx-display/widgets-earnings-calendar'

const domNode = document.getElementById('widget-container')
const dataProviders = {
    ipfPath: '/your-path/ipf',
    ipfAuthHeader: 'your-header',
    fundamentalsPath: '/api/fundamentals',
    fundamentalsAuthHeader: 'your-header',
    schedulePath: '/api/schedule'
}
const widget = newEarningsCalendarWidget({
  element: domNode,
  providers: dataProviders,
})

Signature

newEarningsCalendarWidget(props: WidgetConstructorProps): WidgetAPI

Returns

An WidgetAPI object.

WidgetConstructorProps

Name	Type	Description
element	HTMLElement	A DOM element where the widget should be attached.
providers	Providers	An object with configuration for data providers. Refer to the Data Providers section for details
config optional	Config	Initial configuration of the widget
state optional	State	Initial state of the widget
theme optional	ThemeName | Theme	Initial theme of the widget. Refer to the Styling section for details

Widget API

getConfig

Gets the current widget config.

Signature

getConfig(): Config

Returns

Config

---

setConfig

Sets widget config.

Signature

setConfig(config: Config): void

Parameters

Name	Type	Description
config	Config	Configuration object. Omitted or undefined properties will be set to default

---

getState

Gets the current widget state.

Signature

getState(): State

Returns

State

---

updateState

Updates widget state.

Signature

updateState(state: Partial<State>): void

Parameters

Name	Type	Description
state	Partial<State>	State object. Merges with the previous state object.

---

addStateListener

Sets up a function that will be called whenever the state or specified field is changed.

Signature

addStateListener(stateChangeCallback: (state: State) => void): void
addStateListener(field: keyof State, fieldChangeCallback: (field: State[keyof State]) => void): void

Parameters

Name	Type	Description
stateChangeCallback	(state: State) => void	Function that will be called whenever the state is changed.

Or

Name	Type	Description
field	keyof State	The state field to listen for.
fieldChangeCallback	(value: State[keyof State]) => void	Function that will be called whenever the specified field is changed.

---

removeStateListener

Removes an state listener previously registered with addStateListener

Signature

removeStateListener(stateChangeCallback: (state: State) => void): void
removeStateListener(field: keyof State, fieldChangeCallback: (field: State[keyof State]) => void): void

Parameters

Name	Type	Description
stateChangeCallback	(state: State) => void	Listener that will be removed.

Or

Name	Type	Description
field	keyof State	The state field for which to remove a listener.
fieldChangeCallback	(value: State[keyof State]) => void	Listener that will be removed.

---

setSlot

Inserts custom markup into widget UI. Refer to the Extend widget UI section for details.

Signature

setSlot(slot: Slot, element: HTMLElement): void

Parameters

Name	Type	Description
slot	Slot	The place where a provided element is inserted.
element	HTMLElement	An element that is inserted.

---

setTheme

Sets widget theme.

Signature

setTheme(theme: Theme | ThemeName): void

---

unmount

Destroys the widget.

Signature

unmount(): void

Data Providers

The Data Providers object supplies an information about the endpoints required by the widget, such as the path to the endpoint and the authorization key.

interface EarningsCalendarWidgetDataProviders {
  ipfPath: string
  ipfAuthHeader: string
  fundamentalsPath: string
  fundamentalsAuthHeader: string
  schedulePath: string
}

Properties

Name	Type	Description
ipfPath	string	A string containing the path to the endpoint.
ipfAuthHeader	string	A string containing the authentication header for the endpoint.
fundamentalsPath	string	A string containing the path to the endpoint.
fundamentalsAuthHeader	string	A string containing the authentication header for the endpoint.
schedulePath	string	A string containing the path to the endpoint.

Configuration

Configuration is an object that defines the basic behavior of a widget and allows enabling or disabling widget features that cannot be configured within the widget's user interface.

Type

interface EarningsCalendarWidgetConfig {
  periodTabsViewMode?: ToolbarSelectorViewMode,
  periodSelectorViewMode?: ToolbarSelectorViewMode,
  refreshButtonEnabled?: boolean,
  symbolSearchViewMode?: SymbolSearchViewMode,
  symbolSearchOpenMode?: SymbolSearchOpenMode,
  sortable?: boolean,
  filterable?: boolean,
  reorderable?: boolean,
  resizable?: boolean,
  columnSelectMenuEnabled?: boolean,
  delayNotificationEnabled?: boolean,
  symbolScheduleStatusEnabled?: boolean,
  timezone?: string,
  locale?: LocaleSettings,
}

Properties

Name	Type	Default	Description
periodTabsViewMode Optional	ToolbarSelectorViewMode	'available'	View mode of the period tabs in the toolbar.
periodSelectorViewMode Optional	ToolbarSelectorViewMode	'available'	View mode of the period picker in the toolbar.
refreshButtonEnabled Optional	boolean	true	A flag that controls the refresh button visibility in the toolbar.
symbolSearchViewMode Optional	SymbolSearchViewMode	'available'	View mode of the symbol search in the toolbar.
symbolSearchOpenMode Optional	SymbolSearchOpenMode	'popup'	Open mode of the symbol search in the toolbar.
sortable Optional	boolean	true	A flag that controls the table sorting feature.
filterable Optional	boolean	true	A flag that controls the filtering function of table columns.
reorderable Optional	boolean	true	A flag that controls the column reorder feature.
resizable Optional	boolean	true	A flag that controls the column resizing feature.
columnSelectMenuEnabled Optional	boolean	false	A flag that controls the column select menu feature visibility. Disabling this feature will lead to inability to change columns.
delayNotificationEnabled Optional	boolean	false	A flag that controls a visibility of an data delay notification.
symbolScheduleStatusEnabled Optional	boolean	false	A flag that controls a visibility of symbol schedule status in symbol column in table.
timezone Optional	string	client environment timezone	String corresponds to IANA Time Zone name used to display dates in spicified time zone
locale Optional	LocaleSettings	{ language: 'en', dateLocale: 'en-GB', numberLocale: 'en-GB' }	An object that defines the language and regional settings of the widget.

State

State is an object that represents the state of the widget.

Type

interface EarningsCalendarWidgetState {
  symbols: string[],
  selectedSymbol?: string,
  columns: EarningsCalendarColumnId[],
  columnSizes: EarningsCalendarColumnSizes,
  period: EarningsCalendarPeriod,
  filters: EarningsCalendarFilters,
  sort?: Sort<EarningsCalendarColumnId>,
}

Properties

Name	Type	Default	Description
symbols	string[]	[]	A list of strings containing symbols for which earnings announcements will be displayed.
selectedSymbol Optional	string	undefined	A string containing the symbol selected in the table.
columns	EarningsCalendarColumnId[]	[ 'symbol', 'announcementTime', 'companyName', 'marketCap', 'announcementType', 'referencePeriod', 'forecastedEPS', 'actualEPS', 'surprise', 'announcementDay' ]	A list that represent table columns and its order in table.
columnSizes	EarningsCalendarColumnSizes	{}	An object that specifies column sizes for table columns where key is a column identificator and value is a column width in pixels. If the object does not contain a column width, then default width is used.
period	EarningsCalendarPeriod	'today'	A string or object that represent date range for earnings announcements
filters	EarningsCalendarFilters	{}	An object that defines enabled filters and their parameters.
sort Optional	Sort<EarningsCalendarColumnId>	undefined	An object that defines table sort.

Type Reference

Slot

Type

'header'

---

EarningsCalendarColumnSizes

Type

Record<EarningsCalendarColumnId, number>

---

EarningsCalendarColumnId

Type

'announcementTime' | 'symbol' | 'companyName' | 'marketCap' | 'announcementType' | 'referencePeriod' | 'forecastedEPS' | 'actualEPS' | 'surprise' | 'announcementDay'

---

ToolbarSelectorViewMode

Type

'available' | 'hidden'

---

EarningsCalendarPeriod

Type

'yesterday' | 'today' | 'tomorrow' | 'thisWeek' | 'nextWeek' | 'thisMonth' | 'prevMonth' | 'nextMonth' | {
    from: number,
    to: number,
}

---

SymbolSearchOpenMode

Type

'popup' | 'modal'

---

EconomicCalendarFilters

Type

Partial<Record<EarningsCalendarColumnId, Filter>>

---

Filter

Type

{
  name: string,
  argument: A,
}

---

Sort

An object that defines table sort.

Type

{
  property: EarningsCalendarColumnId,
  direction: SortDirection,
}

---

SortDirection

Direction of the sort.

Type

'ascending' | 'descending'

---

LocaleSettings

An object that defines the language and regional settings of the widget.

Type

{
  language: Language,
  dateLocale: string,
  numberLocale: string,
}

---

Language

Type

'en' | 'de' | 'ar'