Options
All
  • Public
  • Public/Protected
  • All
Menu

Landscape

Index

Functions

deriveAxes

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

    deprecated

    Migrate to [deriveDimensions].

    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 [IAxes] structure containing x and y axes.

deriveDimensions

  • deriveDimensions(applications: Array<IUsage>): Record<string, IAxis>
  • Extracts all the dimensions seen within the the use of the applications as a set of axis objects.

    Parameters

    • applications: Array<IUsage>

      The application data to extract the dimensions of.

    Returns Record<string, IAxis>

    an dictionary of [IAxis] structures, keyed by the dimension name.

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: (scenarios: Array<IAxes>) => IAxes = scenarios => scenarios[0]

      A function

    • Default value xF: (axis: IAxis) => Array<Array<string>> = flexOrder

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

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

          Returns Array<Array<string>>

    • Default value yF: (axis: IAxis) => Array<Array<string>> = flexOrder

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

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

          Returns Array<Array<string>>

    Returns IAxes

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

getTable

  • 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

  • Structures and denormalises the application data aligned to a chosen pair of axes.

    Parameters

    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