Description

A shape task creates a configurable shape by creating a svg tag.

This plugin has the following built-in shapes:

  • rectangle - rectangle shape including round rectangle via cx,cy fields.
  • line - x,y and directional shape.
  • circle
  • speech - round rectangle with left and right speech triangle.
 

API

ShapeTaskName

public export type

export type ShapeTaskName = 'shape';

ShapeTaskParams

public export type

export type ShapeTaskParams =
    | RectangleShapeTaskParams
    | LineShapeTaskParams
    | CircleShapeTaskParams
    | SpeechShapeTaskParams;
 

BaseShapeTaskParams

public export interface

export interface BaseShapeTaskParams extends AnyParams{ }

BaseShapeTaskParams.shape

public property [BaseShapeTaskParams]

shape?: Shapes | string;

BaseShapeTaskParams.stroke

public property [BaseShapeTaskParams]

stroke?: string;

BaseShapeTaskParams.strokeWidth

public property [BaseShapeTaskParams]

strokeWidth?: uint | ExprString;

BaseShapeTaskParams.fill

public property [BaseShapeTaskParams]

fill?: string;
 

RectangleShapeTaskParams

public export interface

export interface RectangleShapeTaskParams extends BaseShapeTaskParams{ }

RectangleShapeTaskParams.width

public property [RectangleShapeTaskParams]

width?: uint | ExprString;

RectangleShapeTaskParams.height

public property [RectangleShapeTaskParams]

height?: uint | ExprString;

RectangleShapeTaskParams.rx

public property [RectangleShapeTaskParams]

rx?: uint | ExprString;

RectangleShapeTaskParams.ry

public property [RectangleShapeTaskParams]

ry?: uint | ExprString;
 

LineShapeTaskParams

public export interface

export interface LineShapeTaskParams extends BaseShapeTaskParams{ }

LineShapeTaskParams.x

public property [LineShapeTaskParams]

x?: int | ExprString;

LineShapeTaskParams.y

public property [LineShapeTaskParams]

y?: int | ExprString;

LineShapeTaskParams.direction

public property [LineShapeTaskParams]

direction?: number | ExprString;

LineShapeTaskParams.length

public property [LineShapeTaskParams]

length?: number | ExprString;
 

CircleShapeTaskParams

public export interface

export interface CircleShapeTaskParams extends BaseShapeTaskParams{ }

CircleShapeTaskParams.radius

public property [CircleShapeTaskParams]

radius?: number | ExprString;
 

SpeechShapeTaskParams

public export interface

export interface SpeechShapeTaskParams extends RectangleShapeTaskParams{ }

SpeechShapeTaskParams.speechPosition

public property [SpeechShapeTaskParams]

speechPosition?: SpeechPosition | string;

SpeechShapeTaskParams.speechStart

public property [SpeechShapeTaskParams]

speechStart?: uint;

SpeechShapeTaskParams.speechWidth

public property [SpeechShapeTaskParams]

speechWidth?: uint;

SpeechShapeTaskParams.speechHeight

public property [SpeechShapeTaskParams]

speechHeight?: uint;

SpeechShapeTaskParams.speechShift

public property [SpeechShapeTaskParams]

speechShift?: int;