Class OIStroke

Hierarchy

OISymbolBase<Stroke>
- OIStroke

Index

Accessors

Constructors

Methods

addPointer clone computePressure create filterPointByAcquisitionDelta formatToSend isIntersected overlaps split substract toJSON

Properties

creationTime decorators deleting id isClosed length modificationDate pointerType pointers selected style transform type

Accessors

bounds

get bounds(): Box
Returns Box
- Defined in primitive/OIStroke.ts:32

edges

get edges(): TSegment[]
Returns TSegment[]
Inherited from OISymbolBase.edges
- Defined in primitive/OISymbolBase.ts:45

snapPoints

get snapPoints(): TPoint[]
Returns TPoint[]
Overrides OISymbolBase.snapPoints
- Defined in primitive/OIStroke.ts:77

vertices

get vertices(): TPoint[]
Returns TPoint[]
Overrides OISymbolBase.vertices
- Defined in primitive/OIStroke.ts:82

Constructors

constructor

new OIStroke(style?, pointerType?): OIStroke
Parameters
- Optional style: {
      color?: string;
      fill?: string;
      opacity?: number;
      width?: number;
  }
  - Optional color?: string
  - Optional fill?: string
  - Optional opacity?: number
  - Optional width?: number
- pointerType: string = "pen"
Returns OIStroke
Overrides OISymbolBase.constructor
- Defined in primitive/OIStroke.ts:22

Methods

addPointer

addPointer(pointer): void
Parameters
- pointer: TPointer
Returns void
- Defined in primitive/OIStroke.ts:110

clone

clone(): OIStroke
Returns OIStroke
Overrides OISymbolBase.clone
- Defined in primitive/OIStroke.ts:131

`Protected` computePressure

computePressure(distance): number
Parameters
- distance: number
Returns number
- Defined in primitive/OIStroke.ts:87

`Static` create

create(partial): OIStroke
Parameters
- partial: {
      addPointer?: any;
      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;
      decorators?: (undefined | ({ id?: string | undefined; kind?: DecoratorKind | undefined; style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; } | undefined; clone?: {} | undefined; }))[];
      deleting?: boolean;
      edges: undefined | (undefined | ({ p1?: { x?: number | undefined; y?: number | undefined; } | undefined; p2?: { x?: number | undefined; y?: number | undefined; } | undefined; }))[];
      formatToSend?: any;
      id?: string;
      isClosed?: false;
      isIntersected?: any;
      length?: number;
      modificationDate?: number;
      overlaps?: any;
      pointerType?: string;
      pointers?: (undefined | ({ x?: number | undefined; y?: number | undefined; t?: number | undefined; p?: 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?: Stroke;
      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 decorators?: (undefined | ({ id?: string | undefined; kind?: DecoratorKind | undefined; style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; } | undefined; clone?: {} | undefined; }))[]
  - 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?: false
  - Optional length?: number
  - Optional modificationDate?: number
  - Optional pointerType?: string
  - Optional pointers?: (undefined | ({ x?: number | undefined; y?: number | undefined; t?: number | undefined; p?: 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?: Stroke
  - vertices: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[]
Returns OIStroke
- Defined in primitive/OIStroke.ts:176

`Protected` filterPointByAcquisitionDelta

filterPointByAcquisitionDelta(point): boolean
Parameters
- point: TPointer
Returns boolean
- Defined in primitive/OIStroke.ts:101

formatToSend

formatToSend(): TStrokeToSend
Returns TStrokeToSend
- Defined in primitive/OIStroke.ts:145

isIntersected

isIntersected(seg): boolean
Parameters
- seg: TSegment
Returns boolean
Inherited from OISymbolBase.isIntersected
- Defined in primitive/OISymbolBase.ts:72

overlaps

overlaps(box): boolean
Parameters
- box: TBoundingBox
Returns boolean
Overrides OISymbolBase.overlaps
- Defined in primitive/OIStroke.ts:122

`Static` split

split(strokeToSplit, i): {
after: OIStroke;
before: OIStroke;
}
Parameters
- strokeToSplit: OIStroke
- i: number
Returns {
after: OIStroke;
before: OIStroke;
}
- after: OIStroke
- before: OIStroke
- Defined in primitive/OIStroke.ts:37

`Static` substract

substract(stroke, partStroke): {
after?: OIStroke;
before?: OIStroke;
}
Parameters
- stroke: OIStroke
- partStroke: OIStroke
Returns {
after?: OIStroke;
before?: OIStroke;
}
- Optional after?: OIStroke
- Optional before?: OIStroke
- Defined in primitive/OIStroke.ts:48

toJSON

toJSON(): {
    addPointer?: any;
    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;
    decorators?: (undefined | ({ id?: string | undefined; kind?: DecoratorKind | undefined; style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; } | undefined; clone?: {} | undefined; }))[];
    deleting?: boolean;
    edges: undefined | (undefined | ({ p1?: { x?: number | undefined; y?: number | undefined; } | undefined; p2?: { x?: number | undefined; y?: number | undefined; } | undefined; }))[];
    formatToSend?: any;
    id?: string;
    isClosed?: false;
    isIntersected?: any;
    length?: number;
    modificationDate?: number;
    overlaps?: any;
    pointerType?: string;
    pointers?: (undefined | ({ x?: number | undefined; y?: number | undefined; t?: number | undefined; p?: 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?: Stroke;
    vertices: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[];
}
Returns {
    addPointer?: any;
    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;
    decorators?: (undefined | ({ id?: string | undefined; kind?: DecoratorKind | undefined; style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; } | undefined; clone?: {} | undefined; }))[];
    deleting?: boolean;
    edges: undefined | (undefined | ({ p1?: { x?: number | undefined; y?: number | undefined; } | undefined; p2?: { x?: number | undefined; y?: number | undefined; } | undefined; }))[];
    formatToSend?: any;
    id?: string;
    isClosed?: false;
    isIntersected?: any;
    length?: number;
    modificationDate?: number;
    overlaps?: any;
    pointerType?: string;
    pointers?: (undefined | ({ x?: number | undefined; y?: number | undefined; t?: number | undefined; p?: 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?: Stroke;
    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 decorators?: (undefined | ({ id?: string | undefined; kind?: DecoratorKind | undefined; style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; } | undefined; clone?: {} | undefined; }))[]
- 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?: false
- Optional length?: number
- Optional modificationDate?: number
- Optional pointerType?: string
- Optional pointers?: (undefined | ({ x?: number | undefined; y?: number | undefined; t?: number | undefined; p?: 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?: Stroke
- vertices: undefined | (undefined | ({ x?: number | undefined; y?: number | undefined; }))[]
Overrides OISymbolBase.toJSON
- Defined in primitive/OIStroke.ts:165

Properties

creationTime

creationTime: number

decorators

decorators: OIDecorator[]

deleting

deleting: boolean

id

id: string

`Readonly` isClosed

isClosed: false = false

length

length: number

modificationDate

modificationDate: number

pointerType

pointerType: string

pointers

pointers: TPointer[]

selected

selected: boolean

style

style: TStyle

transform

transform: MatrixTransform

`Readonly` type

type: Stroke

Class OIStroke

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

bounds

Returns Box

edges

Returns TSegment[]

snapPoints

Returns TPoint[]

vertices

Returns TPoint[]

Constructors

constructor

Parameters

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

Optional color?: string

Optional fill?: string

Optional opacity?: number

Optional width?: number

pointerType: string = "pen"

Returns OIStroke

Methods

addPointer

Parameters

pointer: TPointer

Returns void

clone

Returns OIStroke

Protected computePressure

Parameters

distance: number

Returns number

Static create

Parameters

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 decorators?: (undefined | ({ id?: string | undefined; kind?: DecoratorKind | undefined; style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; } | undefined; clone?: {} | undefined; }))[]

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?: false

Optional length?: number

Optional modificationDate?: number

Optional pointerType?: string

Optional pointers?: (undefined | ({ x?: number | undefined; y?: number | undefined; t?: number | undefined; p?: 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?: Stroke

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

Returns OIStroke

Protected filterPointByAcquisitionDelta

Parameters

point: TPointer

Returns boolean

formatToSend

Returns TStrokeToSend

isIntersected

Parameters

seg: TSegment

Returns boolean

overlaps

Parameters

box: TBoundingBox

Returns boolean

Static split

Parameters

strokeToSplit: OIStroke

i: number

Returns { after: OIStroke; before: OIStroke; }

after: OIStroke

before: OIStroke

Static substract

Parameters

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

`Optional` color?: string

`Optional` fill?: string

`Optional` opacity?: number

`Optional` width?: number

`Protected` computePressure

`Static` create

`Optional` creationTime?: number

`Optional` decorators?: (undefined | ({ id?: string | undefined; kind?: DecoratorKind | undefined; style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; } | undefined; clone?: {} | undefined; }))[]

`Optional` deleting?: boolean

`Optional` id?: string

`Optional` `Readonly` isClosed?: false

`Optional` length?: number

`Optional` modificationDate?: number

`Optional` pointerType?: string

`Optional` pointers?: (undefined | ({ x?: number | undefined; y?: number | undefined; t?: number | undefined; p?: number | undefined; }))[]

`Optional` selected?: boolean

`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?: Stroke

`Protected` filterPointByAcquisitionDelta

`Static` split

Returns {
after: OIStroke;
before: OIStroke;
}

`Static` substract

Returns {
after?: OIStroke;
before?: OIStroke;
}

`Optional` after?: OIStroke

`Optional` before?: OIStroke

`Optional` creationTime?: number

`Optional` decorators?: (undefined | ({ id?: string | undefined; kind?: DecoratorKind | undefined; style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; } | undefined; clone?: {} | undefined; }))[]

`Optional` deleting?: boolean

`Optional` id?: string

`Optional` `Readonly` isClosed?: false

`Optional` length?: number

`Optional` modificationDate?: number

`Optional` pointerType?: string

`Optional` pointers?: (undefined | ({ x?: number | undefined; y?: number | undefined; t?: number | undefined; p?: number | undefined; }))[]

`Optional` selected?: boolean

`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?: Stroke

`Readonly` isClosed

`Readonly` type