Class AspectRatioHandler

An AspectRatioHandler provides the proper width and height of a canvas given an AspectRatio and resolution.

Index

Constructors

Accessors

Methods

buildAspectRatio buildAspectRatioFromDimensions

Constructors

constructor

new AspectRatioHandler(aspectRatio, baseResolution): AspectRatioHandler
Parameters
- aspectRatio: AspectRatio
  If this aspect ratio has a width ratio less than 1 or a height ratio less than 1, then width and height will both return 0.
- baseResolution: number
  If this values is less than or equal to 0, width and height will both return 0.
Returns AspectRatioHandler
- Defined in sketch/canvas/aspect-ratio/aspect-ratio-handler.ts:47

Accessors

height

get height(): number
The calculated canvas height.

Returns number
- Defined in sketch/canvas/aspect-ratio/aspect-ratio-handler.ts:74

width

get width(): number
The calculated canvas width.

Returns number
- Defined in sketch/canvas/aspect-ratio/aspect-ratio-handler.ts:61

Methods

`Static`buildAspectRatio

buildAspectRatio(widthRatio, heightRatio, name?): undefined | AspectRatio
Creates an AspectRatio object with the given width ratio, height ratio, and name.
Parameters
- widthRatio: number
  If this value is less than 1, this method will return undefined.
- heightRatio: number
  If this value is less than 1, this method will return undefined.
- Optionalname: string
  If this value is not specified, the name of the AspectRatio object will be derived from the widthRatio and heightRatio parameters.
Returns undefined | AspectRatio
- Defined in sketch/canvas/aspect-ratio/aspect-ratio-handler.ts:92

`Static`buildAspectRatioFromDimensions

buildAspectRatioFromDimensions(width, height, name?): undefined | AspectRatio
Parameters
- width: number
- height: number
- Optionalname: string
Returns undefined | AspectRatio
- Defined in sketch/canvas/aspect-ratio/aspect-ratio-handler.ts:117