Options
All
  • Public
  • Public/Protected
  • All
Menu

landscape

Index

Type aliases

Dimension

Dimension: keyof IDimensions

An enumeration of the valid dimension names; dynamically generated from the IDimensions interface.

Functions

filter

  • filter(applications: Array<IApplication>, useCriteria?: function | undefined, appCriteria?: function | undefined): Array<IApplication>
  • Filter a set of applications based on application and/or usage criteria.

    Parameters

    • applications: Array<IApplication>

      The set of applications to filter.

    • Default value useCriteria: function | undefined = fTrue

      The application usage criteria.

    • Default value appCriteria: function | undefined = fTrue

      The application criteria

    Returns Array<IApplication>

    The filtered set of applications

filterByDate

  • Filters the applications to determine what was in use at a particular point in time.

    remarks

    The filter uses the optional commissioned and decomissioned date of the application use records.

    Parameters

    • applications: Array<IApplication>

      The full set of applications.

    • date: Date

      The date to filter the applications by.

    Returns Array<IApplication>

    Returns the subset of applications that were in use on the specified date.

getAxis

  • Returns the unique set of values within an application data set for a given dimension.

    Parameters

    Returns IAxis

    Returns the axis with its values.

getHTML

  • getHTML(table: Array<Array<Cell>>): string
  • Renders a table as HTML.

    Parameters

    • table: Array<Array<Cell>>

      The application table, returned by [getTable]

    Returns string

getOptimalAxes

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

    Parameters

    • applications: Array<IApplication>

      The raw application data

    • x: IAxis

      The x axis

    • y: IAxis

      The y axis

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

      A function

    • Default value xF: function = 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: function = 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

    Returns Array<Array<Cell>>

Generated using TypeDoc