Have ideas to improve npm?Join in the discussion! »

    @stubbydigits/aspect-ratio

    1.0.5 • Public • Published

    Aspect ratio

    GitHub Workflow Status GitHub issues GitHub code size in bytes npm (scoped) npm

    NPM Package

    Calculate aspect ratios.

    Usage

    Library exports a single function calculateRatio(x, y) which returns the result object. x and y are numbers. X is always the bigger number.

    Result object

    The program returns an object with two properties

      {
        match : {},
        sortedRatios : [],
      }
    • match : Calculated aspect ratio if there is an exact match
    • sortedRatios : List of aspect ratios ordered by proximity to the original dimensions

    Result format

    Result for both match and sortedRatios is of the following format

    {
      name: "19by16", // usable name for program literals
      ratio: "19:16", // Common name for the aspect ratio, if any
      proximity : "0.123", // ascending numeric valu to represent closeness to the dimensions provided
      description: "Sometimes referred to as the Movietone ratio, this ratio was used briefly during the transitional period when the film industry was converting to sound, from 1926 to 1932 approx. It is produced by superimposing an optical soundtrack over a full-gate 1.3 aperture in printing, resulting in an almost square image. Films shot in this ratio are often projected or transferred to video incorrectly using a 1.37 mask or squashed to 1.37. Examples of films shot in the Movietone ratio include Sunrise, M, Hallelujah! and The Lighthouse."
      // Description for the aspect ratio, usages and history.
    }

    Install

    npm i @stubbydigits/aspect-ratio

    DownloadsWeekly Downloads

    52

    Version

    1.0.5

    License

    MIT

    Unpacked Size

    17.7 kB

    Total Files

    11

    Last publish

    Collaborators

    • avatar