Class AlluvialChartModel

axisFlavor

exportToCSV

• exportToCSV(): void

• Returns void

formatTable

• formatTable(__namedParameters: { cells: any; headers: any }): any[]

• Parameters

  • __namedParameters: { cells: any; headers: any }

  Returns any[]

get

• get(property?: string): any

• Parameters

  • Optionalproperty: string

  Returns any

getActiveDataGroupNames

• getActiveDataGroupNames(groups?: any): any

• Parameters

  • Optionalgroups: any

  Returns any

getActiveDataGroups

• getActiveDataGroups(groups?: any): any

• Parameters

  • Optionalgroups: any

  Returns any

getAllDataFromDomain

• getAllDataFromDomain(groups?: any): any

• Parameters

  • Optionalgroups: any

  Returns any

getAllDataGroupsNames

• getAllDataGroupsNames(): string[]

• Returns string[]

getBinConfigurations

• getBinConfigurations(): { bins: Bin<number, number>[]; binsDomain: any[] }

• Returns { bins: Bin<number, number>[]; binsDomain: any[] }

getBinnedStackedData

• getBinnedStackedData(): SeriesPoint<{ [key: string]: number }>[][]

• Returns SeriesPoint<{ [key: string]: number }>[][]

getColorClassName

• getColorClassName(
      configs: {
          classNameTypes?: interfaces.ColorClassNameTypes[];
          dataGroupName?: string | number;
          originalClassName?: string;
          value?: number;
      },
  ): string

• Parameters

  • configs: {
        classNameTypes?: interfaces.ColorClassNameTypes[];
        dataGroupName?: string | number;
        originalClassName?: string;
        value?: number;
    }

  Returns string

getData

• getData(): any

• Returns any

getDataGroupNames

• getDataGroupNames(groups?: any): any

• Parameters

  • Optionalgroups: any

  Returns any

getDataGroups

• getDataGroups(groups?: any): any

• Parameters

  • Optionalgroups: any

  Returns any

getDataValuesGroupedByKeys

• getDataValuesGroupedByKeys(__namedParameters: StackKeysParams): any

• Parameters

  • __namedParameters: StackKeysParams

  Returns any

getDisplayData

• getDisplayData(groups?: any): any

• Charts that have group configs passed into them, only want to retrieve the display data relevant to that chart

  Parameters

  • Optionalgroups: any

    the included datasets for the particular chart

  Returns any

getFillColor

• getFillColor(group: any, key?: any, data?: any): any

• Parameters

  • group: any
  • Optionalkey: any
  • Optionaldata: any

  Returns any

getGroupedData

• getGroupedData(groups?: any): { data: any; name: string }[]

• Parameters

  • Optionalgroups: any

  Returns { data: any; name: string }[]

getIsFilled

• getIsFilled(group: any, key?: any, data?: any, defaultFilled?: boolean): any

• Should the data point be filled?

  Parameters

  • group: any
  • Optionalkey: any
  • Optionaldata: any
  • OptionaldefaultFilled: boolean

    the default for this chart

  Returns any

getOptions

• getOptions(): any

• Retrieves the current options from the instance's state.

  Returns any

  • The current options stored in the instance's state.

getStackedData

• getStackedData(__namedParameters: StackKeysParams): any[][]

• Parameters

  • __namedParameters: StackKeysParams

  Returns any[][]

getStackKeys

• getStackKeys(__namedParameters?: StackKeysParams): any

• Parameters

  • __namedParameters: StackKeysParams = ...

  Returns any

getStatus

• getStatus(): any

• For charts that might hold an associated status for their dataset

  Returns any

getStrokeColor

• getStrokeColor(group: any, key?: any, data?: any): any

• Parameters

  • group: any
  • Optionalkey: any
  • Optionaldata: any

  Returns any

getZoomBarData

• getZoomBarData(): any

• Returns any

isDataEmpty

• isDataEmpty(): boolean

• Returns boolean

isUserProvidedColorScaleValid

• isUserProvidedColorScaleValid(): any

• Returns any

set

• set(newState: any, configs?: any): void

• Parameters

  • newState: any
  • Optionalconfigs: any

  Returns void

setData

• setData(newData: any): any

• Sets the data for the current instance.

  This method sanitizes the provided data, generates data groups, and updates the instance's state with the sanitized data and data groups.

  Parameters

  • newData: any

    The new data to be set. This data will be cloned and sanitized.

  Returns any

  • The sanitized version of the provided data.

setOptions

• setOptions(newOptions: any): void

• Updates the current options for the instance.

  This method retrieves the existing options, updates the legend additional items, and merges the new options with the existing ones. The instance's state is then updated with the merged options.

  Parameters

  • newOptions: any

    The new options to be set. These options will be merged with the existing options.

  Returns void

setZoomBarData

• setZoomBarData(newZoomBarData?: any): void

• Sets the zoom bar data for the current instance.

  This method sanitizes the provided zoom bar data or uses the display data if no explicit zoom data is provided. It normalizes the zoom bar data by aggregating values based on unique dates and updates the instance's state with the normalized data.

  Parameters

  • OptionalnewZoomBarData: any

    The new zoom bar data to be set. If not provided, the display data will be used.

  Returns void

toggleDataLabel

• toggleDataLabel(changedLabel: string): void

• Parameters

  • changedLabel: string

  Returns void

update

• update(animate?: boolean): void

• Updates miscellanous information within the model such as the color scales, or the legend data labels

  Parameters

  • animate: boolean = true

  Returns void