@thoughtspot/ts-chart-sdk 0.0.2-alpha.2 → 0.0.2-alpha.21

package/dist/ts-chart-sdk.d.ts

@@ -0,0 +1,940 @@
+// Generated by dts-bundle v0.7.3
+// Dependencies for this module:
+//   ../react
+
+import React from 'react';
+
+export type Maybe<T> = T | null;
+export type InputMaybe<T> = Maybe<T>;
+export type Scalars = {
+    ID: string;
+    String: string;
+    Boolean: boolean;
+    Int: number;
+    Float: number;
+    FileUpload: unknown;
+    GUID: string;
+    JSON: {
+        [key: string]: unknown;
+    };
+    JSONObject: unknown;
+    Long: unknown;
+};
+export enum CustomizableChartFeature {
+    X_AXIS_LABEL = 0,
+    X_AXIS_TITLE = 1,
+    Y_AXIS_LABEL = 2,
+    Y_AXIS_TITLE = 3,
+    TOOLTIP = 4,
+    SCATTER_CHART = 5,
+    PIE_CHART = 6,
+    LINE_CHART = 7,
+    COLUMN_CHART = 8,
+    BAR_CHART = 9,
+    AREA_CHART = 10,
+    TAIL_FEATURE = 11
+}
+export interface ChartConfigDimension {
+    key: string;
+    columns: ChartColumn[];
+}
+export interface ChartConfig {
+    key: string;
+    dimensions: ChartConfigDimension[];
+}
+export type DataPointsArray = {
+    columns: string[];
+    dataValue: any[][];
+};
+export type QueryData = {
+    data: DataPointsArray;
+    completionRatio?: number;
+    samplingRatio?: number;
+    totalRowCount: number;
+};
+export interface ChartModel {
+    columns: ChartColumn[];
+    data?: QueryData[];
+    sortInfo?: any;
+    visualProps?: VisualProps;
+    config: {
+        chartConfig?: ChartConfig[];
+    };
+}
+export type SuccessValidationResponse = {
+    chartConfigEditorDefinition: ChartConfigEditorDefinition[];
+    visualPropEditorDefinition: VisualPropEditorDefinition;
+};
+export type ValidationResponse = {
+    isValid: boolean;
+    validationErrorMessage?: string[];
+};
+export type VisualProps = unknown;
+export type TSFontFace = {
+    guid: string | null;
+    family?: string;
+    format?: string;
+    url?: string;
+    weight?: string;
+    style?: string;
+    size?: string;
+    unicodeRange?: string;
+    variant?: string;
+    stretch?: string;
+    color?: string;
+};
+export type ChartSdkCustomStylingConfig = {
+    appBackground?: {
+        color?: string;
+    };
+    appPanelColor?: {
+        color?: string;
+    };
+    chartColorPalettes?: Array<{
+        colors: Array<string>;
+    }>;
+    numColorPalettes?: number;
+    disableColorRotation?: boolean;
+    chartFeatureToFontGuid?: Record<CustomizableChartFeature, string>;
+    fontFaces?: Array<TSFontFace>;
+};
+export interface DateFormats {
+    DATE_SHORT: string;
+    DATE_SHORT_2_DIGIT_YEAR: string;
+    DATE_SHORT_WITH_HOUR: string;
+    DATE_SHORT_WITH_HOUR_WITHOUT_YEAR: string;
+    DATE_SHORT_WITH_HOUR_24: string;
+    DATE_SHORT_WITH_HOUR_24_WITHOUT_YEAR: string;
+    DATETIME_SHORT: string;
+    DATETIME_SHORT_WITHOUT_YEAR: string;
+    DATETIME_24_SHORT: string;
+    DATETIME_24_SHORT_WITH_MILLIS: string;
+    DATETIME_24_SHORT_WITH_MILLIS_WITHOUT_YEAR: string;
+    DATETIME_SHORT_WITH_SECONDS: string;
+    DATETIME_SHORT_WITH_SECONDS_WITHOUT_YEAR: string;
+    DATETIME_SHORT_WITH_MILLIS: string;
+    DATETIME_SHORT_WITH_MILLIS_WITHOUT_YEAR: string;
+    QUARTER_WITH_YEAR: string;
+    QUARTER_WITH_2_DIGIT_YEAR: string;
+    DEFAULT_TIME_FORMAT: string;
+    MONTH_WITH_YEAR: string;
+    MONTH_WITH_DAY_AND_YEAR: string;
+    MONTH_WITH_2_DIGIT_YEAR: string;
+    DAY_WITH_MONTH: string;
+    DAY_WITH_MONTH_NUM: string;
+    QUARTER: string;
+    MONTH_ONLY: string;
+    DATETIME_WITH_SHORT_OFFSET: string;
+}
+export type ChartSdkDateFormatsConfig = {
+    tsLocaleBasedDateFormats?: Record<string, DateFormats>;
+    tsLocaleBasedStringsFormats?: Record<string, string>;
+    tsDateConstants?: Record<string, string>;
+    tsDefinedCustomCalenders?: any;
+    defaultDataSourceId?: string;
+};
+export interface AppConfig {
+    styleConfig?: ChartSdkCustomStylingConfig;
+    dateFormatsConfig?: ChartSdkDateFormatsConfig;
+    appOptions?: {
+        isMobile?: boolean;
+        isPrintMode?: boolean;
+        isLiveboardContext?: boolean;
+        isDebugMode?: boolean;
+    };
+    localeOptions?: {
+        locale: string;
+        quarterStartMonth: string;
+        sessionTimezone: string;
+    };
+    appUrl?: string;
+    customCalendarConfig?: any;
+    chartAppAccessToken?: string;
+}
+
+export interface ChartConfigSection {
+    key: string;
+    label: string;
+    maxColumnCount?: number;
+    allowMeasureColumns?: boolean;
+    allowAttributeColumns?: boolean;
+    allowTimeSeriesColumns?: boolean;
+    allowMeasureNameColumn?: boolean;
+    allowMeasureValueColumn?: boolean;
+}
+export interface ChartConfigEditorDefinition {
+    key: string;
+    label?: string;
+    descriptionText?: string;
+    columnSections: ChartConfigSection[];
+}
+export type ConfigEditorDefinitionSetter = (currentState: ChartModel, ctx: CustomChartContext) => ChartConfigEditorDefinition[];
+
+export interface InputValidation {
+    required?: boolean;
+    requiredError?: string;
+    regex?: string;
+    regexError?: string;
+    minLength?: number;
+    minLengthError?: string;
+    range?: string;
+    rangeError?: string;
+}
+export interface TextInputFormDetail {
+    type: 'text';
+    key: string;
+    label?: string;
+    password?: boolean;
+    multiline?: boolean;
+    placeholder?: string;
+    defaultValue?: string;
+    inputValidation?: InputValidation;
+    disabled?: boolean;
+}
+export interface NumberInputFormDetail {
+    type: 'number';
+    key: string;
+    label?: string;
+    defaultValue?: number;
+    inputValidation?: InputValidation;
+    disabled?: boolean;
+}
+export interface ColorPickerFormDetail {
+    type: 'colorpicker';
+    key: string;
+    label?: string;
+    selectorType?: 'FONT' | 'COLOR';
+    defaultValue?: string;
+}
+export interface ToggleFormDetail {
+    type: 'toggle';
+    key: string;
+    label?: string;
+    defaultValue?: boolean;
+    disabled?: boolean;
+}
+export interface CheckboxFormDetail {
+    type: 'checkbox';
+    key: string;
+    label?: string;
+    defaultValue?: boolean;
+    disabled?: boolean;
+}
+export interface RadioButtonFormDetail {
+    type: 'radio';
+    key: string;
+    label?: string;
+    defaultValue?: string;
+    values: string[];
+    disabled?: boolean;
+}
+export interface DropDownFormDetail {
+    type: 'dropdown';
+    key: string;
+    label?: string;
+    defaultValue?: string;
+    values: string[];
+    disabled?: boolean;
+}
+export interface Section {
+    type: 'section';
+    key: string;
+    label?: string;
+    children?: PropElement[];
+    alignment?: 'row' | 'column';
+    layoutType?: 'accordion' | 'tab' | 'none';
+    disabled?: boolean;
+    isAccordianExpanded?: boolean;
+}
+export type PropElement = Section | TextInputFormDetail | NumberInputFormDetail | ColorPickerFormDetail | ToggleFormDetail | CheckboxFormDetail | RadioButtonFormDetail | DropDownFormDetail;
+export interface ColumnProp {
+    type: ColumnType;
+    columnSettingsDefinition: {
+        [columnId: string]: {
+            elements: PropElement[];
+        };
+    };
+}
+export interface VisualPropEditorDefinition {
+    elements: PropElement[];
+    columnsVizPropDefinition?: ColumnProp[];
+}
+export type VisualEditorDefinitionSetter = (currentState: ChartModel, ctx: CustomChartContext, activeColumnId?: string) => VisualPropEditorDefinition;
+
+export enum ColumnType {
+    UNKNOWN = 0,
+    MEASURE = 1,
+    ATTRIBUTE = 2,
+    VIRTUAL = 3
+}
+export enum ChartSpecificColumnType {
+    UNKNOWN = 0,
+    MEASURE_NAMES = 1,
+    MEASURE_VALUES = 2
+}
+export enum DataType {
+    UNKNOWN = 0,
+    BOOL = 1,
+    CHAR = 2,
+    INT32 = 3,
+    INT64 = 4,
+    FLOAT = 5,
+    DOUBLE = 6,
+    DATE = 7,
+    DATE_TIME = 8,
+    TIME = 9,
+    MAX_TYPE = 10
+}
+export enum ColumnTimeBucket {
+    NO_BUCKET = 0,
+    DAILY = 1,
+    WEEKLY = 2,
+    MONTHLY = 3,
+    QUARTERLY = 4,
+    YEARLY = 5,
+    HOURLY = 6,
+    AUTO = 7,
+    HOUR_OF_DAY = 8,
+    DAY_OF_WEEK = 9,
+    DAY_OF_MONTH = 10,
+    DAY_OF_QUARTER = 11,
+    DAY_OF_YEAR = 12,
+    WEEK_OF_MONTH = 13,
+    WEEK_OF_QUARTER = 14,
+    WEEK_OF_YEAR = 15,
+    MONTH_OF_QUARTER = 16,
+    MONTH_OF_YEAR = 17,
+    QUARTER_OF_YEAR = 18
+}
+export enum FormatType {
+    NONE = 0,
+    PATTERN = 1,
+    PERCENTAGE = 2,
+    CURRENCY = 3
+}
+export enum CurrencyFormatType {
+    USER_LOCALE = 0,
+    COLUMN = 1,
+    ISO_CODE = 2
+}
+export enum ColumnAggregationType {
+    AGGREGATE = 0,
+    AGGREGATE_DISTINCT = 1,
+    APPROX_AGGR_DISTINCT = 2,
+    APPROX_AGGR_DISTINCT_MERGE = 3,
+    APPROX_COUNT_DISTINCT = 4,
+    AVERAGE = 5,
+    COUNT = 6,
+    COUNT_DISTINCT = 7,
+    CUMULATIVE_AVERAGE = 8,
+    CUMULATIVE_COUNT = 9,
+    CUMULATIVE_MAX = 10,
+    CUMULATIVE_MIN = 11,
+    CUMULATIVE_SUM = 12,
+    GROWTH = 13,
+    MAX = 14,
+    MEDIAN = 15,
+    MIN = 16,
+    MOVING_AVERAGE = 17,
+    MOVING_COUNT = 18,
+    MOVING_MAX = 19,
+    MOVING_MIN = 20,
+    MOVING_SUM = 21,
+    NONE = 22,
+    PERCENTILE = 23,
+    RANK = 24,
+    RANK_PERCENTILE = 25,
+    SQL_BOOL_AGGREGATE_OP = 26,
+    SQL_DATE_AGGREGATE_OP = 27,
+    SQL_DATE_TIME_AGGREGATE_OP = 28,
+    SQL_DOUBLE_AGGREGATE_OP = 29,
+    SQL_INT_AGGREGATE_OP = 30,
+    SQL_STRING_AGGREGATE_OP = 31,
+    SQL_TIME_AGGREGATE_OP = 32,
+    STD_DEVIATION = 33,
+    SUM = 34,
+    TABLE_AGGR = 35,
+    VARIANCE = 36
+}
+export interface CurrencyFormat {
+    type: CurrencyFormatType;
+    column: string;
+    isoCode: string;
+}
+export interface ColumnFormat {
+    type: FormatType;
+    pattern?: string;
+    currencyFormat?: CurrencyFormat;
+}
+export interface ChartColumn {
+    id: string;
+    name: string;
+    type: ColumnType;
+    timeBucket: ColumnTimeBucket;
+    dataType: DataType;
+    format?: ColumnFormat;
+    columnProperties?: {
+        conditionalFormatting?: Maybe<ConditionalFormatting>;
+        numberFormatting?: Maybe<FormatConfig>;
+    };
+    aggregationType?: ColumnAggregationType;
+    customOrder?: Array<string>;
+    calenderGuid?: string;
+    chartSpecificColumnType: ChartSpecificColumnType;
+}
+
+export enum ChartToTSEvent {
+    OpenContextMenu = "OpenContextMenu",
+    CloseContextMenu = "CloseContextMenu",
+    OpenAxisMenu = "OpenAxisMenu",
+    CloseAxisMenu = "CloseAxisMenu",
+    InitStart = "InitStart",
+    RenderStart = "RenderStart",
+    RenderError = "RenderError",
+    RenderComplete = "RenderComplete",
+    UpdateVisualProps = "UpdateVisualProps",
+    GetTMLString = "GetTMLString",
+    SetTMLString = "SetTMLString",
+    GetDataForQuery = "GetDataForQuery",
+    ShowToolTip = "ShowToolTip",
+    HideToolTip = "HideToolTip"
+}
+export interface ChartToTSEventsPayloadMap {
+    [ChartToTSEvent.OpenContextMenu]: [OpenContextMenuEventPayload];
+    [ChartToTSEvent.CloseContextMenu]: [];
+    [ChartToTSEvent.InitStart]: [];
+    [ChartToTSEvent.RenderStart]: [];
+    [ChartToTSEvent.RenderComplete]: [];
+    [ChartToTSEvent.RenderError]: [RenderErrorEventPayload];
+    [ChartToTSEvent.UpdateVisualProps]: [UpdateVisualPropsEventPayload];
+    [ChartToTSEvent.GetTMLString]: [];
+    [ChartToTSEvent.SetTMLString]: [SetTMLStringEventPayload];
+    [ChartToTSEvent.GetDataForQuery]: [GetDataForQueryEventPayload];
+    [ChartToTSEvent.ShowToolTip]: [ShowToolTipEventPayload];
+    [ChartToTSEvent.HideToolTip]: [];
+    [ChartToTSEvent.OpenAxisMenu]: [OpenAxisMenuEventPayload];
+    [ChartToTSEvent.CloseAxisMenu]: [];
+}
+export interface UpdateVisualPropsEventPayload {
+    visualProps: VisualProps;
+}
+export interface SetTMLStringEventPayload {
+    tmlString: string;
+}
+export interface PointVal {
+    columnId: string;
+    value: any;
+}
+export interface Point {
+    tuple: PointVal[];
+}
+export interface CustomAction {
+    id: string;
+    label: string;
+    icon?: string;
+    onClick: (...args: any[]) => void;
+}
+export interface OpenContextMenuEventPayload {
+    event: Pick<PointerEvent, 'clientX' | 'clientY'>;
+    clickedPoint: Point;
+    selectedPoints?: Point[];
+    customActions?: CustomAction[];
+}
+export interface ShowToolTipEventPayload {
+    event: Pick<PointerEvent, 'clientX' | 'clientY'>;
+    customTooltipContent?: string[];
+    point?: Point;
+}
+export interface RenderErrorEventPayload {
+    hasError: boolean;
+    error: any;
+}
+export interface GetDataForQueryEventPayload {
+    queries: Query[];
+}
+export enum ErrorType {
+    MultipleContextsNotSupported = "MultipleContextsNotSupported"
+}
+export enum AxisMenuActions {
+    AGGREGATE = "AGGREGATE",
+    TIME_BUCKET = "TIME_BUCKET",
+    FILTER = "FILTER",
+    SORT = "SORT",
+    SEPARATOR = "SEPARATOR"
+}
+export interface AxisMenuCustomAction {
+    id: string;
+    label: string;
+    icon?: string;
+    onClick: (...args: any[]) => void;
+}
+export interface OpenAxisMenuEventPayload {
+    event: Pick<PointerEvent, 'clientX' | 'clientY'>;
+    columnIds: string[];
+    selectedActions?: AxisMenuActions[];
+    customActions?: AxisMenuCustomAction[];
+}
+export interface ContextMenuActionHandler {
+    [key: string]: (args: CustomContextMenuAction) => void;
+}
+export interface AxisMenuActionHandler {
+    [key: string]: (args: CustomAxisMenuAction) => void;
+}
+
+export enum TSToChartEvent {
+    Initialize = "Initialize",
+    InitializeComplete = "InitializeComplete",
+    GetDataQuery = "GetDataQuery",
+    ChartConfigValidate = "ChartConfigValidate",
+    ChartModelUpdate = "ChartModelUpdate",
+    DataUpdate = "DataUpdate",
+    TriggerRenderChart = "TriggerRenderChart",
+    VisualPropsValidate = "VisualPropsValidate",
+    VisualPropsUpdate = "VisualPropsUpdate",
+    ContextMenuActionClick = "ContextMenuActionClick",
+    AxisMenuActionClick = "AxisMenuActionClick"
+}
+export interface TSToChartEventsPayloadMap {
+    [TSToChartEvent.ChartModelUpdate]: (payload: ChartModelUpdateEventPayload) => void;
+    [TSToChartEvent.DataUpdate]: (payload: DataUpdateEventPayload) => void;
+    [TSToChartEvent.VisualPropsUpdate]: (payload: VisualPropsUpdateEventPayload) => void;
+}
+export interface TSToChartInternalEventsPayloadMap {
+    [TSToChartEvent.Initialize]: (payload: InitializeEventPayload) => InitializeEventResponsePayload;
+    [TSToChartEvent.InitializeComplete]: () => void;
+    [TSToChartEvent.GetDataQuery]: (payload: GetDataQueryPayload) => GetDataQueryResponsePayload;
+    [TSToChartEvent.ChartConfigValidate]: (payload: ChartConfigValidateEventPayload) => ValidationResponse;
+    [TSToChartEvent.VisualPropsValidate]: (payload: VisualPropsValidateEventPayload) => ValidationResponse;
+    [TSToChartEvent.TriggerRenderChart]: () => void;
+    [TSToChartEvent.ContextMenuActionClick]: (payload: ContextMenuCustomActionPayload) => void;
+    [TSToChartEvent.AxisMenuActionClick]: (payload: AxisMenuCustomActionPayload) => void;
+}
+export interface InitializeEventPayload {
+    chartModel: ChartModel;
+    appConfig?: AppConfig;
+    componentId: string;
+    hostUrl: string;
+    containerElSelector: string;
+}
+export interface InitializeEventResponsePayload {
+    isConfigValid: boolean;
+    defaultChartConfig: ChartConfig[];
+    chartConfigEditorDefinition?: ChartConfigEditorDefinition[];
+    visualPropEditorDefinition?: VisualPropEditorDefinition;
+    allowedConfigurations?: AllowedConfigurations;
+    chartConfigParameters?: ChartConfigParameters;
+}
+export interface GetDataQueryPayload {
+    config: ChartConfig[];
+}
+export interface QueryColumn extends ChartColumn {
+    isMeasureValue?: boolean;
+}
+export interface Query {
+    queryColumns: QueryColumn[];
+    queryParams?: {
+        offset?: number;
+        size?: number;
+    };
+}
+export interface GetDataQueryResponsePayload {
+    queries: Query[];
+}
+export interface ChartModelUpdateEventPayload {
+    chartModel: ChartModel;
+}
+export interface DataUpdateEventPayload {
+    data: QueryData[];
+}
+export interface VisualPropsUpdateEventPayload {
+    visualProps: VisualProps;
+}
+export interface VisualPropsValidateEventPayload {
+    visualProps: VisualProps;
+    activeColumnId?: string;
+}
+export interface ChartConfigValidateEventPayload {
+    chartConfig: ChartConfig[];
+}
+export interface CustomContextMenuAction {
+    id: string;
+    clickedPoint: Point;
+    selectedPoints?: Point[];
+    event: Pick<PointerEvent, 'clientX' | 'clientY'>;
+}
+export interface ContextMenuCustomActionPayload {
+    customAction: CustomContextMenuAction;
+}
+export interface CustomAxisMenuAction {
+    id: string;
+    columnIds: string[];
+    event: Pick<PointerEvent, 'clientX' | 'clientY'>;
+}
+export interface AxisMenuCustomActionPayload {
+    customAction: CustomAxisMenuAction;
+}
+
+export type AllowedConfigurations = {
+    allowColumnNumberFormatting?: boolean;
+    allowColumnConditionalFormatting?: boolean;
+    allowMeasureNamesAndValues?: boolean;
+};
+export type ChartConfigParameters = {
+    measureNameValueColumns?: {
+        enableMeasureNameColumn?: boolean;
+        enableMeasureValueColumn?: boolean;
+        measureNameColumnAlias?: string;
+        measureValueColumnAlias?: string;
+    };
+    batchSizeLimit?: number;
+};
+export type CustomChartContextProps = {
+    getDefaultChartConfig: (chartModel: ChartModel) => ChartConfig[];
+    getQueriesFromChartConfig: (chartConfig: ChartConfig[], chartModel: ChartModel) => Query[];
+    renderChart: (ctx: CustomChartContext) => Promise<void>;
+    validateConfig?: (updatedConfig: ChartConfig[], chartModel: ChartModel) => ValidationResponse;
+    validateVisualProps?: (updatedVisualProps: VisualProps, chartModel: ChartModel, activeColumnId?: string) => ValidationResponse;
+    chartConfigEditorDefinition?: ConfigEditorDefinitionSetter | ChartConfigEditorDefinition[];
+    visualPropEditorDefinition?: VisualEditorDefinitionSetter | VisualPropEditorDefinition;
+    allowedConfigurations?: AllowedConfigurations;
+    chartConfigParameters?: ChartConfigParameters;
+};
+export type ValidationFunctions = CustomChartContextProps['validateVisualProps'] | CustomChartContextProps['validateConfig'];
+export class CustomChartContext {
+    containerEl: HTMLElement | null;
+    constructor(chartContextProps: CustomChartContextProps);
+    initialize: () => Promise<void>;
+    on<T extends keyof TSToChartEventsPayloadMap>(eventType: T, callbackFn: TSToChartEventsPayloadMap[T]): void;
+    off<T extends keyof TSToChartEventsPayloadMap>(eventType: T): void;
+    destroy(): void;
+    getChartModel: () => ChartModel;
+    getAppConfig: () => AppConfig;
+    contextMenuCustomActionPreProcessor(eventPayload: [OpenContextMenuEventPayload]): [OpenContextMenuEventPayload];
+    axisMenuCustomActionPreProcessor(eventPayload: [OpenAxisMenuEventPayload]): [OpenAxisMenuEventPayload];
+    emitEvent<T extends keyof ChartToTSEventsPayloadMap>(eventType: T, ...eventPayload: ChartToTSEventsPayloadMap[T]): Promise<any>;
+}
+export const getChartContext: (customChartConfig: CustomChartContextProps) => Promise<CustomChartContext>;
+
+export const useChartContext: (props: Omit<CustomChartContextProps, 'renderChart'>) => ChartContextProps;
+
+export type ConditionalFormatting = {
+    __typename?: 'ConditionalFormatting';
+    rows?: Maybe<Array<Maybe<ConditionalMetric>>>;
+};
+export enum BackgroundFormatTypes {
+    Gradient = "GRADIENT",
+    Solid = "SOLID"
+}
+export enum ConditionalFormattingComparisonTypes {
+    ColumnBased = "COLUMN_BASED",
+    ParameterBased = "PARAMETER_BASED",
+    ValueBased = "VALUE_BASED"
+}
+export type FontAttrs = {
+    __typename?: 'FontAttrs';
+    bold?: Maybe<Scalars['Boolean']>;
+    color?: Maybe<Scalars['String']>;
+    italic?: Maybe<Scalars['Boolean']>;
+    strikeThrough?: Maybe<Scalars['Boolean']>;
+    underline?: Maybe<Scalars['Boolean']>;
+};
+export type GradientBackgroundAttrs = {
+    __typename?: 'GradientBackgroundAttrs';
+    backgroundFormatMidpoint?: Maybe<Scalars['Float']>;
+    backgroundFormatRange?: Maybe<Array<Maybe<Scalars['Float']>>>;
+    colors?: Maybe<Array<Maybe<Scalars['String']>>>;
+};
+export enum Operators {
+    Contains = "CONTAINS",
+    DoesNotContain = "DOES_NOT_CONTAIN",
+    EndsWith = "ENDS_WITH",
+    EqualTo = "EQUAL_TO",
+    GreaterThan = "GREATER_THAN",
+    GreaterThanEqualTo = "GREATER_THAN_EQUAL_TO",
+    Is = "IS",
+    IsBetween = "IS_BETWEEN",
+    IsEmpty = "IS_EMPTY",
+    IsNot = "IS_NOT",
+    IsNotEmpty = "IS_NOT_EMPTY",
+    IsNotNull = "IS_NOT_NULL",
+    IsNull = "IS_NULL",
+    LessThan = "LESS_THAN",
+    LessThanEqualTo = "LESS_THAN_EQUAL_TO",
+    NotEqualTo = "NOT_EQUAL_TO",
+    StartsWith = "STARTS_WITH"
+}
+export type SolidBackgroundAttrs = {
+    __typename?: 'SolidBackgroundAttrs';
+    color?: Maybe<Scalars['String']>;
+};
+export type Range = {
+    __typename?: 'Range';
+    max?: Maybe<Scalars['Float']>;
+    min?: Maybe<Scalars['Float']>;
+};
+export type ConditionalMetric = {
+    __typename?: 'ConditionalMetric';
+    backgroundFormatType?: Maybe<BackgroundFormatTypes>;
+    comparisonParameterId?: Maybe<Scalars['String']>;
+    comparisonType?: Maybe<ConditionalFormattingComparisonTypes>;
+    fontProperties?: Maybe<FontAttrs>;
+    gradientBackgroundAttrs?: Maybe<GradientBackgroundAttrs>;
+    isHighlightRow?: Maybe<Scalars['Boolean']>;
+    lhsColumnId?: Maybe<Scalars['String']>;
+    operator?: Maybe<Operators>;
+    plotAsBand?: Maybe<Scalars['Boolean']>;
+    rangeValues?: Maybe<Range>;
+    rhsColumnId?: Maybe<Scalars['String']>;
+    solidBackgroundAttrs?: Maybe<SolidBackgroundAttrs>;
+    value?: Maybe<Scalars['String']>;
+};
+export type Parameter = {
+    __typename?: 'Parameter';
+    dataType: FalconDataType;
+    defaultValue: Scalars['String'];
+    description: Scalars['String'];
+    id: Scalars['GUID'];
+    name: Scalars['String'];
+    overrideValue?: Maybe<Scalars['String']>;
+    owner: ParameterOwnerInfo;
+    valueList?: Maybe<Array<ParameterValueListItem>>;
+    valueRange?: Maybe<ParameterValueRange>;
+    valueType: ParameterValueType;
+};
+export enum FalconDataType {
+    Bool = "BOOL",
+    Char = "CHAR",
+    Date = "DATE",
+    DateTime = "DATE_TIME",
+    Double = "DOUBLE",
+    Float = "FLOAT",
+    Int32 = "INT32",
+    Int64 = "INT64",
+    List = "LIST",
+    ListBool = "LIST_BOOL",
+    ListDate = "LIST_DATE",
+    ListDateTime = "LIST_DATE_TIME",
+    ListDouble = "LIST_DOUBLE",
+    ListInt = "LIST_INT",
+    ListString = "LIST_STRING",
+    ListTime = "LIST_TIME",
+    MaxType = "MAX_TYPE",
+    Time = "TIME",
+    Unknown = "UNKNOWN"
+}
+export type ParameterOwnerInfo = {
+    __typename?: 'ParameterOwnerInfo';
+    id: Scalars['GUID'];
+    name: Scalars['String'];
+    type: ParameterOwnerType;
+};
+export enum ParameterOwnerType {
+    Answer = "ANSWER",
+    Worksheet = "WORKSHEET"
+}
+export type ParameterValueListItem = {
+    __typename?: 'ParameterValueListItem';
+    displayAs?: Maybe<Scalars['String']>;
+    value: Scalars['String'];
+};
+export type ParameterValueListItemInput = {
+    displayAs?: InputMaybe<Scalars['String']>;
+    value: Scalars['String'];
+};
+export type ParameterValueRange = {
+    __typename?: 'ParameterValueRange';
+    max?: Maybe<Scalars['Float']>;
+    min?: Maybe<Scalars['Float']>;
+};
+export type ParameterValueRangeInput = {
+    max?: InputMaybe<Scalars['Float']>;
+    min?: InputMaybe<Scalars['Float']>;
+};
+export enum ParameterValueType {
+    Any = "ANY",
+    List = "LIST",
+    Range = "RANGE"
+}
+
+export enum CategoryType {
+    Currency = "CURRENCY",
+    Custom = "CUSTOM",
+    Number = "NUMBER",
+    Percentage = "PERCENTAGE"
+}
+export enum Unit {
+    Auto = "AUTO",
+    Billion = "BILLION",
+    Million = "MILLION",
+    None = "NONE",
+    Thousands = "THOUSANDS",
+    Trillion = "TRILLION"
+}
+export enum NegativeValueFormat {
+    BracesNodash = "BRACES_NODASH",
+    PrefixDash = "PREFIX_DASH",
+    SuffixDash = "SUFFIX_DASH"
+}
+export type CurrencyFormatConfig = {
+    __typename?: 'CurrencyFormatConfig';
+    decimals?: Maybe<Scalars['Float']>;
+    locale?: Maybe<Scalars['String']>;
+    removeTrailingZeroes?: Maybe<Scalars['Boolean']>;
+    toSeparateThousands?: Maybe<Scalars['Boolean']>;
+    unit?: Maybe<Unit>;
+};
+export type CustomFormatConfig = {
+    __typename?: 'CustomFormatConfig';
+    format?: Maybe<Scalars['String']>;
+};
+export type NumberFormatConfig = {
+    __typename?: 'NumberFormatConfig';
+    decimals?: Maybe<Scalars['Float']>;
+    negativeValueFormat?: Maybe<NegativeValueFormat>;
+    removeTrailingZeroes?: Maybe<Scalars['Boolean']>;
+    toSeparateThousands?: Maybe<Scalars['Boolean']>;
+    unit?: Maybe<Unit>;
+};
+export type PercentageFormatConfig = {
+    __typename?: 'PercentageFormatConfig';
+    decimals?: Maybe<Scalars['Float']>;
+    removeTrailingZeroes?: Maybe<Scalars['Boolean']>;
+};
+export type FormatConfig = {
+    __typename?: 'FormatConfig';
+    category?: Maybe<CategoryType>;
+    currencyFormatConfig?: Maybe<CurrencyFormatConfig>;
+    customFormatConfig?: Maybe<CustomFormatConfig>;
+    isCategoryEditable?: Maybe<Scalars['Boolean']>;
+    numberFormatConfig?: Maybe<NumberFormatConfig>;
+    percentageFormatConfig?: Maybe<PercentageFormatConfig>;
+};
+
+export interface CustomCalendarDate {
+    v: {
+        s: number;
+        e: number;
+    };
+    d: string;
+}
+export const dateFormatPresets: {
+    DATE_SHORT: string;
+    DATE_SHORT_WITH_HOUR: string;
+    DATE_SHORT_WITH_HOUR_WITHOUT_YEAR: string;
+    DATETIME_SHORT: string;
+    DATETIME_SHORT_WITHOUT_YEAR: string;
+    DATETIME_SHORT_WITH_SECONDS: string;
+    DATETIME_SHORT_WITH_MILLIS: string;
+    MONTH_WITH_YEAR: string;
+    QUARTER_WITH_YEAR: string;
+    QUARTER_WITH_2_DIGIT_YEAR: string;
+    DEFAULT_TIME_FORMAT: string;
+    TIME_24_WITH_SECONDS: string;
+    DATE_SHORT_2_DIGIT_YEAR: string;
+    DATETIME_24_SHORT_WITHOUT_YEAR: string;
+    DATETIME_24_SHORT: string;
+    DATETIME_SHORT_WITH_SECONDS_WITHOUT_YEAR: string;
+    DATETIME_SHORT_WITH_MILLIS_WITHOUT_YEAR: string;
+    DATETIME_24_SHORT_WITH_MILLIS_WITHOUT_YEAR: string;
+    DATETIME_24_SHORT_WITH_MILLIS: string;
+    MONTH_WITH_DAY_AND_YEAR: string;
+    MONTH_WITH_2_DIGIT_YEAR: string;
+    DAY_WITH_MONTH_NUM: string;
+    DATE_SHORT_WITH_HOUR_24_WITHOUT_YEAR: string;
+    DATE_SHORT_WITH_HOUR_24: string;
+    QUARTER: string;
+    MONTH_ONLY: string;
+    DATETIME_WITH_SHORT_OFFSET: string;
+};
+export const dateNumTypes: {
+    DATE_NUM_ABS_DAY: string;
+    DATE_NUM_ABS_MONTH: string;
+    DATE_NUM_ABS_QUARTER: string;
+    DATE_NUM_ABS_YEAR: string;
+    DATE_NUM_DAY_IN_MONTH: string;
+    DATE_NUM_DAY_IN_QUARTER: string;
+    DATE_NUM_DAY_IN_YEAR: string;
+    DATE_NUM_DAY_OF_WEEK: string;
+    DATE_NUM_MONTH_IN_QUARTER: string;
+    DATE_NUM_MONTH_IN_YEAR: string;
+    DATE_NUM_QUARTER_IN_YEAR: string;
+    DATE_NUM_WEEK_IN_YEAR: string;
+    DATE_NUM_WEEK_IN_QUARTER: string;
+    DATE_NUM_WEEK_IN_MONTH: string;
+    DATE_NUM_HOUR_IN_DAY: string;
+};
+export const bucketizationToDatePreset: {
+    HOURLY: string;
+    DAILY: string;
+    WEEKLY: string;
+    MONTHLY: string;
+    QUARTERLY: string;
+    YEARLY: string;
+};
+export const timeBuckets: {
+    NO_BUCKET: string;
+    HOURLY: string;
+    DAILY: string;
+    WEEKLY: string;
+    MONTHLY: string;
+    QUARTERLY: string;
+    YEARLY: string;
+    DAY_OF_WEEK: string;
+    DAY_OF_MONTH: string;
+    DAY_OF_QUARTER: string;
+    DAY_OF_YEAR: string;
+    WEEK_OF_MONTH: string;
+    WEEK_OF_QUARTER: string;
+    WEEK_OF_YEAR: string;
+    MONTH_OF_QUARTER: string;
+    MONTH_OF_YEAR: string;
+    QUARTER_OF_YEAR: string;
+};
+export const isDateColumn: (col: ChartColumn) => boolean;
+export const isAttribute: (col: ChartColumn) => boolean;
+export const isDateTimeColumn: (col: ChartColumn) => boolean;
+export const getCustomCalendarGuidFromColumn: (col: ChartColumn) => string | undefined;
+export const isDateNumColumn: (col: ChartColumn) => boolean;
+export const isDateFamilyColumn: (col: ChartColumn) => boolean;
+export const isTimeColumn: (col: ChartColumn) => boolean;
+export const getEffectiveDateNumDataType: (col: ChartColumn) => string | undefined;
+export const hasCustomCalendar: (col: ChartColumn) => boolean;
+export function getStartEpoch(date: CustomCalendarDate): number | null;
+export const assignQuarterValueToString: (quarter_of_year: any, value: any) => any;
+export function getMonthOfYear(num: any, quarterStartMonth: any, monthOfYear: any): any;
+export function getDisplayString(date: CustomCalendarDate): string | null;
+export const useQuarterStart: (luxonDate: any, quarterStartMonth: any) => any;
+export const getCustomCalendarValueFromEpoch: (col: ChartColumn, dateEpoch: number, displayToCustomCalendarValueMap: any) => any;
+export function getSpecialFormatData(value: string | number, options: any): any;
+export function sanitizeDate(inputDate: string | number, format: string, options: any): any;
+export const formatDateTime: (epochMillis: number, format: string, useSystemCalendar?: boolean, options?: any) => any;
+export function getOrdinalSuffixedValue(i: number | string): string;
+export function formatDateNum(effectiveDataType: string | undefined, value: number | string, formatPattern: string, options: any): any;
+export function formatDate(inputDate: number | string, format: string, useSystemCalendar: boolean, options: any): string;
+
+export const getMinRangeValue: (metric: ConditionalMetric) => number | undefined | null;
+export const getMaxRangeValue: (metric: ConditionalMetric) => number | undefined | null;
+export const isConditionSatisfied: (metric: ConditionalMetric, parameters?: Parameter[], lhsColValue?: string | number | null, rhsColValue?: string | number | null) => boolean;
+export function validateCfCondition(conditionalMetric: ConditionalMetric, index: number, columnId: string, dataAttr?: DataPointsArray, inScopeParameters?: Parameter[]): boolean;
+export const applicableConditionalFormatting: (idx: number, columnId: string, dataArr: DataPointsArray, conditionalFormatting?: ConditionalFormatting) => ConditionalMetric | null;
+export function getCfForColumn(column: ChartColumn): ConditionalFormatting | undefined;
+
+export type ChartToTSEventEmitters = {
+    [key in keyof ChartToTSEventsPayloadMap as `emit${Capitalize<key>}`]: (...args: ChartToTSEventsPayloadMap[key]) => Promise<void>;
+};
+export type TSToChartEventListener = {
+    [key in keyof TSToChartEventsPayloadMap as `setOn${Capitalize<key>}`]: (args: TSToChartEventsPayloadMap[key]) => Promise<void>;
+};
+export type TSToChartEventOffListener = {
+    [key in keyof TSToChartEventsPayloadMap as `setOff${Capitalize<key>}`]: () => Promise<void>;
+};
+export interface TSChartContextProps {
+    children: React.ReactNode;
+}
+export interface ChartContextProps extends ChartToTSEventEmitters, TSToChartEventListener, TSToChartEventOffListener {
+    hasInitialized: boolean;
+    chartModel: ChartModel | undefined;
+    destroy: () => void;
+    TSChartContext: ({ children }: TSChartContextProps) => React.JSX.Element;
+}
+