Class OIShapePolygon

bounds

• get bounds(): Box

• Returns Box

vertices

• get vertices(): TPoint[]

• Returns TPoint[]

constructor

• new OIShapePolygon(points, style?): OIShapePolygon

• Parameters

  • points: TPoint[]

  • Optional style: {
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
    }

    • Optional color?: string

    • Optional fill?: string

    • Optional opacity?: number

    • Optional width?: number

  Returns OIShapePolygon

clone

• clone(): OIShapePolygon

• Returns OIShapePolygon

Static create

• create(partial): OIShapePolygon

• Parameters

  • partial: {
        bounds: undefined | ({ x?: number | undefined; y?: number | undefined; width?: number | undefined; height?: number | undefined; readonly xMin?: number | undefined; readonly xMid?: number | undefined; readonly xMax?: number | undefined; ... 9 more ...; overlaps?: {} | undefined; });
        clone?: any;
        creationTime?: number;
        deleting?: boolean;
        edges: undefined | (undefined | ({ p1?: { x?: number | undefined; y?: number | undefined; } | undefined; p2?: { x?: number | undefined; y?: number | undefined; } | undefined; }))[];
        id?: string;
        isClosed?: true;
        isIntersected?: any;
        kind?: Polygon;
        modificationDate?: number;
        overlaps?: any;
        points?: (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
        selected?: boolean;
        snapPoints: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
        style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; };
        toJSON?: any;
        transform?: { xx?: number | undefined; yx?: number | undefined; xy?: number | undefined; yy?: number | undefined; tx?: number | undefined; ty?: number | undefined; invert?: {} | undefined; multiply?: {} | undefined; ... 5 more ...; toCssString?: {} | undefined; };
        type?: Shape;
        vertices: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
    }

    • bounds: undefined | ({ x?: number | undefined; y?: number | undefined; width?: number | undefined; height?: number | undefined; readonly xMin?: number | undefined; readonly xMid?: number | undefined; readonly xMax?: number | undefined; ... 9 more ...; overlaps?: {} | undefined; })

    • Optional creationTime?: number

    • Optional deleting?: boolean

    • edges: undefined | (undefined | ({ p1?: { x?: number | undefined; y?: number | undefined; } | undefined; p2?: { x?: number | undefined; y?: number | undefined; } | undefined; }))[]

    • Optional id?: string

    • Optional Readonly isClosed?: true

    • Optional Readonly kind?: Polygon

    • Optional modificationDate?: number

    • Optional points?: (undefined | ({ x?: number | undefined; y?: number | undefined; }))[]

    • Optional selected?: boolean

    • snapPoints: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[]

    • Optional style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; }

    • Optional transform?: { xx?: number | undefined; yx?: number | undefined; xy?: number | undefined; yy?: number | undefined; tx?: number | undefined; ty?: number | undefined; invert?: {} | undefined; multiply?: {} | undefined; ... 5 more ...; toCssString?: {} | undefined; }

    • Optional Readonly type?: Shape

    • vertices: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[]

  Returns OIShapePolygon

Static createParallelogramBetweenPoints

• createParallelogramBetweenPoints(origin, target, style?): OIShapePolygon

• Parameters

  • origin: TPoint

  • target: TPoint

  • Optional style: {
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
    }

    • Optional color?: string

    • Optional fill?: string

    • Optional opacity?: number

    • Optional width?: number

  Returns OIShapePolygon

Static createRectangleBetweenPoints

• createRectangleBetweenPoints(origin, target, style?): OIShapePolygon

• Parameters

  • origin: TPoint

  • target: TPoint

  • Optional style: {
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
    }

    • Optional color?: string

    • Optional fill?: string

    • Optional opacity?: number

    • Optional width?: number

  Returns OIShapePolygon

Static createRhombusBetweenPoints

• createRhombusBetweenPoints(origin, target, style?): OIShapePolygon

• Parameters

  • origin: TPoint

  • target: TPoint

  • Optional style: {
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
    }

    • Optional color?: string

    • Optional fill?: string

    • Optional opacity?: number

    • Optional width?: number

  Returns OIShapePolygon

Static createTriangleBetweenPoints

• createTriangleBetweenPoints(origin, target, style?): OIShapePolygon

• Parameters

  • origin: TPoint

  • target: TPoint

  • Optional style: {
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
    }

    • Optional color?: string

    • Optional fill?: string

    • Optional opacity?: number

    • Optional width?: number

  Returns OIShapePolygon

toJSON

• toJSON(): {
      bounds: undefined | ({ x?: number | undefined; y?: number | undefined; width?: number | undefined; height?: number | undefined; readonly xMin?: number | undefined; readonly xMid?: number | undefined; readonly xMax?: number | undefined; ... 9 more ...; overlaps?: {} | undefined; });
      clone?: any;
      creationTime?: number;
      deleting?: boolean;
      edges: undefined | (undefined | ({ p1?: { x?: number | undefined; y?: number | undefined; } | undefined; p2?: { x?: number | undefined; y?: number | undefined; } | undefined; }))[];
      id?: string;
      isClosed?: true;
      isIntersected?: any;
      kind?: Polygon;
      modificationDate?: number;
      overlaps?: any;
      points?: (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
      selected?: boolean;
      snapPoints: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
      style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; };
      toJSON?: any;
      transform?: { xx?: number | undefined; yx?: number | undefined; xy?: number | undefined; yy?: number | undefined; tx?: number | undefined; ty?: number | undefined; invert?: {} | undefined; multiply?: {} | undefined; ... 5 more ...; toCssString?: {} | undefined; };
      type?: Shape;
      vertices: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
  }

• Returns {
      bounds: undefined | ({ x?: number | undefined; y?: number | undefined; width?: number | undefined; height?: number | undefined; readonly xMin?: number | undefined; readonly xMid?: number | undefined; readonly xMax?: number | undefined; ... 9 more ...; overlaps?: {} | undefined; });
      clone?: any;
      creationTime?: number;
      deleting?: boolean;
      edges: undefined | (undefined | ({ p1?: { x?: number | undefined; y?: number | undefined; } | undefined; p2?: { x?: number | undefined; y?: number | undefined; } | undefined; }))[];
      id?: string;
      isClosed?: true;
      isIntersected?: any;
      kind?: Polygon;
      modificationDate?: number;
      overlaps?: any;
      points?: (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
      selected?: boolean;
      snapPoints: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
      style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; };
      toJSON?: any;
      transform?: { xx?: number | undefined; yx?: number | undefined; xy?: number | undefined; yy?: number | undefined; tx?: number | undefined; ty?: number | undefined; invert?: {} | undefined; multiply?: {} | undefined; ... 5 more ...; toCssString?: {} | undefined; };
      type?: Shape;
      vertices: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
  }

  • bounds: undefined | ({ x?: number | undefined; y?: number | undefined; width?: number | undefined; height?: number | undefined; readonly xMin?: number | undefined; readonly xMid?: number | undefined; readonly xMax?: number | undefined; ... 9 more ...; overlaps?: {} | undefined; })

  • Optional creationTime?: number

  • Optional deleting?: boolean

  • edges: undefined | (undefined | ({ p1?: { x?: number | undefined; y?: number | undefined; } | undefined; p2?: { x?: number | undefined; y?: number | undefined; } | undefined; }))[]

  • Optional id?: string

  • Optional Readonly isClosed?: true

  • Optional Readonly kind?: Polygon

  • Optional modificationDate?: number

  • Optional points?: (undefined | ({ x?: number | undefined; y?: number | undefined; }))[]

  • Optional selected?: boolean

  • snapPoints: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[]

  • Optional style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; }

  • Optional transform?: { xx?: number | undefined; yx?: number | undefined; xy?: number | undefined; yy?: number | undefined; tx?: number | undefined; ty?: number | undefined; invert?: {} | undefined; multiply?: {} | undefined; ... 5 more ...; toCssString?: {} | undefined; }

  • Optional Readonly type?: Shape

  • vertices: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[]

Static updateParallelogramBetweenPoints

• updateParallelogramBetweenPoints(poly, origin, target): OIShapePolygon

• Parameters

  • poly: OIShapePolygon

  • origin: TPoint

  • target: TPoint

  Returns OIShapePolygon

Static updateRectangleBetweenPoints

• updateRectangleBetweenPoints(poly, origin, target): OIShapePolygon

• Parameters

  • poly: OIShapePolygon

  • origin: TPoint

  • target: TPoint

  Returns OIShapePolygon

Static updateRhombusBetweenPoints

• updateRhombusBetweenPoints(poly, origin, target): OIShapePolygon

• Parameters

  • poly: OIShapePolygon

  • origin: TPoint

  • target: TPoint

  Returns OIShapePolygon

Static updateTriangleBetweenPoints

• updateTriangleBetweenPoints(poly, origin, target): OIShapePolygon

• Parameters

  • poly: OIShapePolygon

  • origin: TPoint

  • target: TPoint

  Returns OIShapePolygon

points