BYOC: Read Me

Please update this file for any changes to the contract of what each file would define.

How To Run

Following command will start the application to be able to render any custom chart.

pnpm run dev --port=3000

You ll also need to run ts-mock-app to be able to run the application in sync

pnpm run dev --port=3001

Running localhost:3001 should run the application with custom charts.

File Descriptions

Manifest.json

Description of the custom chart and other related details. This is what user can upload on the custom chart page on TS, and every thing will be captured directly from the file. Users can also manually fill the mentioned details via a form on TS.

index.html

Part of developer defined logic to render the html. This is the first thing, app will render. It also points to the underlying chart rendering logic

src/custom-chart.ts

Entire of custom chart rendering logic

src/lib folder

Contains the main sdk related files. Includes types, context and utils This is not part of the custom chart implementation.

common.types.ts

All the structured metadata types and event and event payload types.

configurator.types.ts

Types for definition of custom column configurator on TS.

visual-props.types.ts

Types for definition of visual props editor on TS.

custom-chart-context.ts

Contains the main context file for the

utils.ts

Context based utility functions.