Interface ICanvasMediaMutableProps

Extended mutable properties for the CanvasMedia class.

interface ICanvasMediaMutableProps {
    __mutableProp?: true;
    dpr?: number | "auto";
    height?: number | "auto";
    rule?:
        | "cover"
        | "contain"
        | "top-left"
        | "top-right"
        | "bottom-left"
        | "bottom-right"
        | "center";
    width?: number
    | "auto";
}

Hierarchy (View Summary)

Properties

__mutableProp? dpr? height? rule? width?

Properties

Optional__mutableProp

__mutableProp?: true

Optionaldpr

dpr?: number | "auto"

Device Pixel Ratio (DPR). Use 'auto' for automatic detection.

Default

'auto'

Optionalheight

height?: number | "auto"

Canvas height. Use 'auto' to match the container's height.

Default

'auto'

Optionalrule

rule?:
    | "cover"
    | "contain"
    | "top-left"
    | "top-right"
    | "bottom-left"
    | "bottom-right"
    | "center"

Defines how the media element is positioned within the canvas.

Default

'cover'

Optionalwidth

width?: number | "auto"

Canvas width. Use 'auto' to match the container's width.

Default

'auto'

Settings

Member Visibility

On This Page

Properties