qualifiers/aspectRatio.ts

import {AspectRatioQualifierValue} from "./aspectRatio/AspectRatioQualifierValue.js";
import {ignoreInitialAspectRatio as ignoreInitialAspectRatioFlag} from "./flag.js";
import {FlagQualifier} from "./flag/FlagQualifier.js";


/**
 * @description 1 by 1 aspect ration.
 * @memberOf Qualifiers.AspectRatio
 * @return {string}
 */
function ar1X1(): AspectRatioQualifierValue {
  return new AspectRatioQualifierValue('1:1');
}

/**
 * @summary qualifier
 * @description 5 by 4 aspect ration.
 * @memberOf Qualifiers.AspectRatio
 * @return {string}
 */
function ar5X4(): AspectRatioQualifierValue {
  return new AspectRatioQualifierValue('5:4');
}

/**
 * @summary qualifier
 * @description 4 by 3 aspect ration.
 * @memberOf Qualifiers.AspectRatio
 * @return {string}
 */
function ar4X3(): AspectRatioQualifierValue {
  return new AspectRatioQualifierValue('4:3');
}

/**
 * @summary qualifier
 * @description 3 by 2 aspect ration.
 * @memberOf Qualifiers.AspectRatio
 * @return {string}
 */
function ar3X2(): AspectRatioQualifierValue {
  return new AspectRatioQualifierValue('3:2');
}

/**
 * @summary qualifier
 * @description 16 by 9 aspect ration.
 * @memberOf Qualifiers.AspectRatio
 * @return {string}
 */
function ar16X9(): AspectRatioQualifierValue {
  return new AspectRatioQualifierValue('16:9');
}

/**
 * @summary qualifier
 * @description 3 by 1 aspect ration.
 * @memberOf Qualifiers.AspectRatio
 * @return {string}
 */
function ar3X1(): AspectRatioQualifierValue {
  return new AspectRatioQualifierValue('3:1');
}

/**
 * @summary qualifier
 * @description ignores aspect ratio.
 * @memberOf Qualifiers.AspectRatio
 * @return {IgnoreAspectRatioQualifier}
 */
function ignoreInitialAspectRatio(): FlagQualifier {
  return ignoreInitialAspectRatioFlag();
}


/**
 * @summary qualifier
 * @description A list of all most commonly used aspect ratios. including an ‘ignore aspect ratio’ option which direct the BE to not stick to the original aspect ratio.
 * This is used in the context of resize actions
 * @namespace AspectRatio
 * @memberOf Qualifiers
 * @see Visit {@link Actions.Resize|Resize} for an example
 */
const AspectRatio = {
  ar1X1,
  ar5X4,
  ar3X1,
  ar3X2,
  ar4X3,
  ar16X9,
  ignoreInitialAspectRatio
};


export {ar1X1, ar5X4, ar3X1, ar3X2, ar4X3, ar16X9, ignoreInitialAspectRatio, AspectRatio};