Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

Denormalised

Denormalised: Array<IApplication & { status: string; usage: { x: string; y: string; }[]; }>

ScenarioGenerator

ScenarioGenerator: function

A generator function that takes an axis and generates the scenarios used in the selection of the optimal axis order.

Type declaration

    • (axis: IAxis): Array<Array<string>>
    • Parameters

      Returns Array<Array<string>>

Functions

deriveAxes

  • deriveAxes(applications: Array<IUsage>, x: string, y: string): IAxes
  • Extracts the list of unique values for a dimension from underlying application data.

    Parameters

    • applications: Array<IUsage>

      The underlying application data.

    • x: string

      The name of the dimension to use as the x axis.

    • y: string

      The name of the dimension to use as the y axis.

    Returns IAxes

    Returns an [IAxis] structure for hte

getHTML

  • getHTML(table: Array<Array<IApplication & ILayout>>): string
  • Renders a table as HTML.

    Parameters

    • table: Array<Array<IApplication & ILayout>>

      The application table, returned by [getTable]

    Returns string

getOptimalAxes

  • Determine the a good order of the axes resulting in a layout with applications grouped together.

    Parameters

    • applications: Array<IApplication & IUsage>

      The raw application data

    • axes: IAxes

      The x and y axes

    • Default value axesSelector: function = scenarios => scenarios[0]

      A function

    • Default value xF: ScenarioGenerator = flexOrder

      The algorithm to use the generate scenarios to test on the x axis; defaults to all permutations.

    • Default value yF: ScenarioGenerator = flexOrder

      The algorithm to use the generate scenarios to test on the y axis; defaults to all permutations.

    Returns IAxes

    Returns all conbinations of x and y axes with the greatest grouping of applications

getOptimalAxesBruteForce

  • Determine the optimum order of the x and y axes resulting in a layout with applications grouped together.

    Parameters

    • applications: Array<IApplication & IUsage>

      The raw application data

    • axes: IAxes

      The x and y axes

    • Default value axesSelector: function = scenarios => scenarios[0]

      A function

    • Default value xF: ScenarioGenerator = flexOrder

      The algorithm to use the generate scenarios to test on the x axis; defaults to all permutations.

    • Default value yF: ScenarioGenerator = flexOrder

      The algorithm to use the generate scenarios to test on the y axis; defaults to all permutations.

    Returns IAxes

    Returns all conbinations of x and y axes with the greatest grouping of applications

getTable

  • getTable(applications: Array<Array<Array<IApplication & IUseDetail>>>, axes: IAxes): Array<Array<IApplication & ILayout>>
  • Prepares application data for rendering according to a selected set of axes.

    Parameters

    • applications: Array<Array<Array<IApplication & IUseDetail>>>

      The structured application data having previously been prepared by a call to [prepareData].

    • axes: IAxes

      The x and y axis.

    Returns Array<Array<IApplication & ILayout>>

prepareData

  • prepareData(applications: Array<IApplication & IUsage>, axes: IAxes): Array<Array<Array<IApplication & IUseDetail>>>
  • Structures and denormalises the application data aligned to a chosen pair of axes.

    Parameters

    • applications: Array<IApplication & IUsage>

      The application data to prepare.

    • axes: IAxes

      The chosen x and y axis.

    Returns Array<Array<Array<IApplication & IUseDetail>>>

    Returns a 2D array representing the chosen axis; each cell containing an array of the applications used in that context.

Generated using TypeDoc