Type Alias TShapeUpdateState

TShapeUpdateState: {
    altitude?: number;
    bevel?: {
        enabled?: boolean;
        offset?: number;
        segments?: number;
        size?: number;
        thickness?: number;
    };
    color?: string;
    height?: number;
    hoverColor?: string;
    interactive?: boolean;
    opacity?: number;
    position?: Coordinate;
    type?: "shape";
    visible?: boolean;
}

A partial shape state used to apply incremental updates, where every field is optional.

Type declaration

  • Optionalaltitude?: number

    The altitude of the shape.

    Default

    0
  • Optionalbevel?: {
        enabled?: boolean;
        offset?: number;
        segments?: number;
        size?: number;
        thickness?: number;
    }

    Bevel configuration for extruded shapes.

  • Optionalcolor?: string

    The color of the shape.

    Default

    #ffffff
  • Optionalheight?: number

    The height of the shape. Height cannot be updated at this time

  • OptionalhoverColor?: string

    Color of the shape when hovered. Color can be set using CSS color names DarkGoldenRod, as hex strings #0000FF or rgb values rgb(255,0,0).

  • Optionalinteractive?: boolean

    Whether the shape is interactive.

    Default

    false
  • Optionalopacity?: number

    The opacity of the shape.

    Default

    1
  • Optionalposition?: Coordinate

    The position of the shape as a Coordinate.

  • Optionaltype?: "shape"

    The type of the shape.

  • Optionalvisible?: boolean

    Whether Shape is visible

    Default

    true

Settings

Member Visibility