@fishjam-cloud/js-server-sdk - v0.29.0
    Preparing search index...

    Interface Rescaler

    Rescaler

    interface Rescaler {
        borderColor?: null | string;
        borderRadius?: null | number;
        borderWidth?: null | number;
        bottom?: null | number;
        boxShadow?: null | BoxShadow[];
        child: Component;
        height?: null | number;
        horizontalAlign?: null | HorizontalAlign;
        id?: null | string;
        left?: null | number;
        mode?: null | RescaleMode;
        right?: null | number;
        rotation?: null | number;
        top?: null | number;
        transition?: null | Transition;
        type: "rescaler";
        verticalAlign?: null | VerticalAlign;
        width?: null | number;
    }
    Index

    Properties

    borderColor? borderRadius? borderWidth? bottom? boxShadow? child height? horizontalAlign? id? left? mode? right? rotation? top? transition? type verticalAlign? width?

    Properties

    borderColor?: null | string

    (default="#00000000") Border color in a "#RRGGBBAA" format.

    Rescaler

    borderRadius?: null | number

    (default=0.0) Radius of a rounded corner.

    Rescaler

    borderWidth?: null | number

    (default=0.0) Border width.

    Rescaler

    bottom?: null | number

    Distance in pixels between the bottom edge of this component and the bottom edge of its parent (including a border). If this field is defined, this element will be absolutely positioned, instead of being laid out by its parent.

    Rescaler

    boxShadow?: null | BoxShadow[]

    List of box shadows.

    Rescaler

    child: Component

    List of component's children.

    Rescaler

    height?: null | number

    Height of a component in pixels (without a border). Exact behavior might be different based on the parent component:

    • If the parent component is a layout, check sections "Absolute positioning" and "Static positioning" of that component.
    • If the parent component is not a layout, then this field is required.

    Rescaler

    horizontalAlign?: null | HorizontalAlign

    (default="center") Horizontal alignment.

    Rescaler

    id?: null | string

    Id of a component.

    Rescaler

    left?: null | number

    Distance in pixels between this component's left edge and its parent's left edge (including a border). If this field is defined, this element will be absolutely positioned, instead of being laid out by its parent.

    Rescaler

    mode?: null | RescaleMode

    (default="fit") Resize mode:

    Rescaler

    right?: null | number

    Distance in pixels between this component's right edge and its parent's right edge. If this field is defined, this element will be absolutely positioned, instead of being laid out by its parent.

    Rescaler

    rotation?: null | number

    Rotation of a component in degrees. If this field is defined, this element will be absolutely positioned, instead of being laid out by its parent.

    Rescaler

    top?: null | number

    Distance in pixels between this component's top edge and its parent's top edge (including a border). If this field is defined, then the component will ignore a layout defined by its parent.

    Rescaler

    transition?: null | Transition

    Defines how this component will behave during a scene update. This will only have an effect if the previous scene already contained a Rescaler component with the same id.

    Rescaler

    type: "rescaler"

    Rescaler

    verticalAlign?: null | VerticalAlign

    (default="center") Vertical alignment.

    Rescaler

    width?: null | number

    Width of a component in pixels (without a border). Exact behavior might be different based on the parent component:

    • If the parent component is a layout, check sections "Absolute positioning" and "Static positioning" of that component.
    • If the parent component is not a layout, then this field is required.

    Rescaler

    Settings

    Member Visibility

    On This Page

    Properties