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

    Interface View

    View

    interface View {
        backgroundColor?: null | string;
        borderColor?: null | string;
        borderRadius?: null | number;
        borderWidth?: null | number;
        bottom?: null | number;
        boxShadow?: null | BoxShadow[];
        children?: null | Component[];
        direction?: null | ViewDirection;
        height?: null | number;
        id?: null | string;
        left?: null | number;
        overflow?: null | Overflow;
        padding?: null | number;
        paddingBottom?: null | number;
        paddingHorizontal?: null | number;
        paddingLeft?: null | number;
        paddingRight?: null | number;
        paddingTop?: null | number;
        paddingVertical?: null | number;
        right?: null | number;
        rotation?: null | number;
        top?: null | number;
        transition?: null | Transition;
        type: "view";
        width?: null | number;
    }
    Index

    Properties

    backgroundColor? borderColor? borderRadius? borderWidth? bottom? boxShadow? children? direction? height? id? left? overflow? padding? paddingBottom? paddingHorizontal? paddingLeft? paddingRight? paddingTop? paddingVertical? right? rotation? top? transition? type width?

    Properties

    backgroundColor?: null | string

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

    View

    borderColor?: null | string

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

    View

    borderRadius?: null | number

    (default=0.0) Radius of a rounded corner.

    View

    borderWidth?: null | number

    (default=0.0) Border width.

    View

    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.

    View

    boxShadow?: null | BoxShadow[]

    List of box shadows.

    View

    children?: null | Component[]

    List of component's children.

    View

    direction?: null | ViewDirection

    Direction defines how static children are positioned inside a View component.

    View

    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.

    View

    id?: null | string

    Id of a component.

    View

    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.

    View

    overflow?: null | Overflow

    (default="hidden") Controls what happens to content that is too big to fit into an area.

    View

    padding?: null | number

    (default=0.0) Padding for all sides of the component.

    View

    paddingBottom?: null | number

    (default=0.0) Padding on bottom side in pixels.

    View

    paddingHorizontal?: null | number

    (default=0.0) Padding for the left and right of the component.

    View

    paddingLeft?: null | number

    (default=0.0) Padding on left side in pixels.

    View

    paddingRight?: null | number

    (default=0.0) Padding on right side in pixels.

    View

    paddingTop?: null | number

    (default=0.0) Padding on top side in pixels.

    View

    paddingVertical?: null | number

    (default=0.0) Padding for the top and bottom of the component.

    View

    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.

    View

    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.

    View

    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.

    View

    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 View component with the same id.

    View

    type: "view"

    View

    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.

    View

    Settings

    Member Visibility

    On This Page

    Properties