@contentauth/c2pa-js
    Preparing search index...

    Interface Shape

    A spatial range representing rectangle, circle, or a polygon.

    interface Shape {
        height?: null | number;
        inside?: null | boolean;
        origin: Coordinate;
        type: ShapeType;
        unit: UnitType;
        vertices?: null | Coordinate[];
        width?: null | number;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    height? inside? origin type unit vertices? width?

    Properties

    height?: null | number

    The height of a rectnagle.

    This field can be ignored for circles and polygons.

    inside?: null | boolean

    If the range is inside the shape.

    The default value is true.

    origin: Coordinate

    THe origin of the coordinate in the shape.

    type: ShapeType

    The type of shape.

    unit: UnitType

    The type of unit for the shape range.

    vertices?: null | Coordinate[]

    The vertices of the polygon.

    This field can be ignored for rectangles and circles.

    width?: null | number

    The width for rectangles or diameter for circles.

    This field can be ignored for polygons.

    Settings

    Member Visibility

    On This Page

    Properties