- Overview
- Requirements
- Getting started
- Basic Customization
- Customization
- Important notes
- Questions and support
- Contributing to this project
The ChartIQ React application features components that enable you to build charting applications in the React framework. The components include everything from a basic chart to a complex, active trader desktop.
React components in react-components/src/ (also available from @chartiq/react-components package on npm)
Chart (Chart/Core)
— Creates a basic chart with a basic user interface. Use with Core package.AdvancedChart (Chart/Advanced)
— Creates a full-featured chart with a fully developed user interface. Use with Technical Analysis package.ActiveTraderWorkstation (ActiveTrader/Workstation)
— Sets up an information-rich desktop for traders who trade frequently.TermStructure (CrossSection/Chart)
— Creates a term structure chart for working with non-time-series data.- NOTE: TermStructure is presently incompatible with library web components version 9.1
- To use this chart, you need to import legacy web components. See the upgrade guide for more information on working with legacy web components.
Custom implementations in src/containers/
MultiChart
— Displays two advanced charts on screen simultaneously.- NOTE: MultiChart is presently incompatible with library web components version 9.1
- To use this chart, you need to import legacy web components. See the upgrade guide for more information on working with legacy web components.
CustomChart
— Integrates native React components with ChartIQ W3C-standard web components.HelloWorld
— Creates a basic chart with no user interface as a starting point for your React app.
For an example of creating a chart user interface entirely with native React components, see the chartiq-react-seed project.
- A copy of the ChartIQ JavaScript library (works best with version 9.1.3).
- If you do not have a copy of the library or need a different version, please contact your account manager or visit our Request Follow-Up Site.
To implement this project:
- Clone the repository.
- Extract the contents of your zipped ChartIQ library package.
- Copy the tarball (.tgz file) from the extracted library package into the root of this project.
- Run the following commands from the root of the project:
npm install ./chartiq-x.x.x.tgz
to install the charting librarynpm install
to install the rest of the dependenciesnpm start
to start up the development server
- Open your browser to http://localhost:4002 to load the application.
Note: When you are upgrading or changing your license, we recommend that you completely remove the old library before reinstalling the new one, for example:
npm uninstall chartiq
npm install ./chartiq-x.x.x.tgz
For basic component customization, see component documentation at react-components/README.
The Template.jsx files of the AdvancedChart
, ActiveTraderWorkstation
, and TermStructure
components and the render
method of CustomChart
contain JSX that is a collection of ChartIQ's user interface web components. You can customize the chart user interface by adding, removing, or modifying UI components. You can also add your own custom React components.
You can configure a variety of chart features by modifying the configuration object provided to the component definition files of AdvancedChart
, CustomChart
, ActiveTrader/Workstation
, and CrossSection/Chart
. Sample configurations are available as getConfig
and getCustomConfig
functions in the resources files.
A default configuration is part of the ChartIQ library. See the Chart Configuration tutorial for all the configuration details.
ChartIQ web components can be customized by extending the web component classes. Customization code should run at the time the chart and user interface are created; that is, in the createChartAndUI
method. We recommend keeping all customization code in a single file or folder to simplify library version upgrades.
Here's an example of customizing the cq-chart-title
component:
// Access the web component classes.
import { CIQ } from 'chartiq/js/componentUI';
// Access the class definition of the web component.
const ChartTitle = CIQ.UI.components('cq-chart-title')[0].classDefinition;
// Extend the web component class.
class CustomChartTitle extends ChartTitle {
update() {
// Execute the original method.
super.update();
// Update the chart title.
const { symbol, symbolDisplay } = this.context.stx.chart;
// If symbolDisplay is available, use it in the document title.
if (symbolDisplay) {
document.title = document.title.replace(symbol, symbolDisplay);
}
}
}
// Update the web component definition.
CIQ.UI.addComponentDefinition('cq-chart-title', CustomChartTitle);
CustomChart
integrates native React components with ChartIQ's W3C-standard web components.
The RecentSymbols
component provides an example of wrapping and enhancing a web component with a React component. RecentSymbols
adds a RECENT tab to the lookup controls created by ChartIQ's cq-lookup
and cq-comparison-lookup
web components. The RECENT tab displays a list of recently used financial instrument symbols maintained by the RecentSymbols
component.
The ShortcutDialog
component is an example of a React component accessed by a web component. User interaction with a dropdown menu created by a ChartIQ cq-menu
web component opens the dialog box created by the ShortcutDialog
component. The dialog box enables users to set shortcut keys on the chart's drawing tools.
-
This application runs only from IP address
127.0.0.1
, hostnamelocalhost
, or the explicit list of domains set on your ChartIQ license. If you need to bind the webpack development server to a different host, please contact your account manager to have additional domains added to your license. -
If the web component polyfill is not required for supported browsers, the download size can be reduced by removing the polyfill script tag in the index.html file.
-
As of version 8.0.0 of the charting library, this project no longer supports Internet Explorer 11. Please contact support@chartiq.com for information on using version 7.5.0 of the charting library to enable this project to work with IE 11.
- Contact our development support team at support@chartiq.com.
- See our SDK documentation at https://documentation.chartiq.com.
Fork it and send us a pull request. We'd love to see what you can do with our charting tools in React!