Class TableChart

__doc__

Optional_tooltip

config

contentDiv

contextMenu

dataStore

dialogs

div

Optionalextra_legends

height

isPinned

legend

legendIcon

listeners

menuSpace

observable

resetButton

OptionalsettingsDialog

title

titleBar

OptionalunpinIcon

width

Statictypes

dataSource

• get dataSource(): DataSource

• Returns DataSource

_addTrimmedColor

• _addTrimmedColor(column: string, conf: any): void

• Parameters

  • column: string
  • conf: any

  Returns void

_addUnpinIcon

• _addUnpinIcon(): void

• Returns void

_callListeners

• _callListeners(type: string, data: any): void

• Parameters

  • type: string
  • data: any

  Returns void

_getContentDimensions

• _getContentDimensions(): {
      height: number;
      left: number;
      top: number;
      width: number;
  }

• Returns { height: number; left: number; top: number; width: number }

_openSettingsDialog

• _openSettingsDialog(e: MouseEvent): void

• Parameters

  • e: MouseEvent

  Returns void

_setConfigValue

• _setConfigValue(conf: any, value: string | number | symbol, def: any): any

• Parameters

  • conf: any
  • value: string | number | symbol
  • def: any

  Returns any

_setDimensions

• _setDimensions(): void

• Returns void

addListener

• addListener(id: string, listener: Listener): void

• Adds a listener to the datastore that will be called when an event occurs, passing the event type and any data. There are the following different types of event:-

  • removed - called when the chart has been removed

  Parameters

  • id: string

    a unique id indetifying the listener
  • listener: Listener

    a function that accepts two paramaters, the type of event and the data associated with it

  Returns void

addMenuIcon

• addMenuIcon(
      icon: string,
      tooltip: string,
      config?: {
          func?: (e: MouseEvent) => void;
          position?: string;
          size?: string;
      },
  ): HTMLSpanElement

• Adds a menu icon with tooltip to the title bar

  Parameters

  • icon: string

    the css classs of the icon (space delimited).
  • tooltip: string

    the tooltip text
  • config: { func?: (e: MouseEvent) => void; position?: string; size?: string } = {}

    extra inormation about the icon/tooltip

    • Optionalfunc?: (e: MouseEvent) => void

      a function that is called when the icon is clicked

    • Optionalposition?: string

      the position of the tooltip.

    • Optionalsize?: string

      the size of the tooltip

  Returns HTMLSpanElement

  • the icon

OptionaladdToContextMenu

• addToContextMenu(): any

• Returns any

  an array of ContextMenuItems

addToolTip

• addToolTip(): void

• Returns void

OptionalcolorByColumn

• colorByColumn(c: string): void

• Parameters

  • c: string

  Returns void

OptionalcolorByDefault

• colorByDefault(): void

• Returns void

downloadImage

• downloadImage(im_type: "svg" | "png"): void

• Downloads an image of the chart

  Parameters

  • im_type: "svg" | "png"

    either svg or png

  Returns void

drawChart

• drawChart(): void

• Returns void

OptionalgetChartData

• getChartData(): any

• Returns any

getColorFunction

• getColorFunction(
      column: string,
      asArray?: boolean,
  ): (i: number) => [number, number, number]

• Parameters

  • column: string
  • OptionalasArray: boolean

  Returns (i: number) => [number, number, number]

getColorLegend

• getColorLegend(): HTMLElement

• Returns HTMLElement

getColorOptions

• getColorOptions(): any

• Returns any

getContextMenu

• getContextMenu(data?: any): ContextMenuItem[]

• Parameters

  • Optionaldata: any

  Returns ContextMenuItem[]

getDiv

• getDiv(): HTMLElement

• Returns the dom element that the chart is attached to

  Returns HTMLElement

getFilter

• getFilter(): any

• Returns any

OptionalgetImage

• getImage(callback: (resp: any) => void, im_type: "svg" | "png"): void

• Parameters

  • callback: (resp: any) => void
  • im_type: "svg" | "png"

  Returns void

getImageFromSVG

• getImageFromSVG(
      svg: any,
      callback: (
          canvas: HTMLCanvasElement,
          ctx: CanvasRenderingContext2D,
      ) => void,
  ): void

• Parameters

  • svg: any
  • callback: (canvas: HTMLCanvasElement, ctx: CanvasRenderingContext2D) => void

  Returns void

getSettings

• getSettings(): GuiSpecs

• Returns information about which controls to add to the settings dialog. Subclasses should call this method and then add their own controls e.g.

  getSettings(){
      let settings = super.getSettings();
      return settings.concat([{
        label:"A value"
        type:"slider",
        default_value:this.config.value,
        max:10,
        min:10,
        func:x=>{
            this.config.value=x;
            //update chart
        }
      }]);
  }
  

  wrapping controls with a call to @{link g} will perform type checking todo- specifiy the link to g above properly/ document better

  Returns GuiSpecs

  an array of objects describing tweakable parameters

hideToolTip

• hideToolTip(): void

• Returns void

onDataAdded

• onDataAdded(newSize: number): void

• Parameters

  • newSize: number

  Returns void

removeFilter

• removeFilter(): void

• needs to be implemented by subclasses

  Returns void

OptionalremoveLayout

• removeLayout(): void

• Returns void

removeListener

• removeListener(id: string): void

• Removes the specified listener from the chart

  Parameters

  • id: string

    The id of the listener to remove

  Returns void

setColorLegend

• setColorLegend(): void

• adds (or removes) the color legend depending on the chart's config color_legend.display value - assumes chart has a get colorLegend method

  Returns void

setFilter

• setFilter(active: boolean): void

• appears to be an appropriate type signature from glancing at uses in the code

  Parameters

  • active: boolean

  Returns void

setTitle

• setTitle(title: string): void

• Parameters

  • title: string

  Returns void

showToolTip

• showToolTip(e: MouseEvent, msg: string): void

• Parameters

  • e: MouseEvent
  • msg: string

  Returns void