Class NgonLayer

Example

const { LazyCanvas, NgonLayer } = require('@hitomihiumi/lazy-canvas')

let ngon = new NgonLayer()
.setRadius(50)
.setSides(6)
.setColor('#fff')

const lazy = new LazyCanvas()
.addLayers(ngon)
//...

Hierarchy (view full)

BaseLayer
- NgonLayer

Index

Constructors

constructor

new NgonLayer(data?): NgonLayer
Parameters
- Optionaldata: LazyCanvasLayer
Returns NgonLayer
Overrides BaseLayer.constructor
- Defined in structures/NgonLayer.ts:24

Properties

data

data: LazyCanvasLayer

Methods

setAlpha

setAlpha(alpha): NgonLayer
Parameters
- alpha: number
  The alpha value of the layer
Returns NgonLayer
Inherited from BaseLayer.setAlpha
- Defined in structures/BaseLayer.ts:171

setColor

setColor(color): NgonLayer
Parameters
- color: string | Gradient | Pattern
  The color of the figure
Returns NgonLayer
- Defined in structures/NgonLayer.ts:73

setFilled

setFilled(fill): NgonLayer
Parameters
- fill: boolean
  Whether the figure should be filled or not
Returns NgonLayer
- Defined in structures/NgonLayer.ts:54

setGlobalCompositeOperation

setGlobalCompositeOperation(operation): NgonLayer
Parameters
- operation:
      | "color"
      | "source-over"
      | "source-in"
      | "source-out"
      | "source-atop"
      | "destination-over"
      | "destination-in"
      | "destination-out"
      | "destination-atop"
      | "lighter"
      | "copy"
      | "xor"
      | "multiply"
      | "screen"
      | "overlay"
      | "darken"
      | "lighten"
      | "color-dodge"
      | "color-burn"
      | "hard-light"
      | "soft-light"
      | "difference"
      | "exclusion"
      | "hue"
      | "saturation"
      | "luminosity"
  The global composite operation of the layer
Returns NgonLayer
Inherited from BaseLayer.setGlobalCompositeOperation
- Defined in structures/BaseLayer.ts:192

setOutline

setOutline(outline): NgonLayer
Parameters
- outline: Outline
  The outline of the figure
Returns NgonLayer
- Defined in structures/NgonLayer.ts:83

setRadius

setRadius(radius): NgonLayer
Parameters
- radius: number
  The radius of the figure
Returns NgonLayer
- Defined in structures/NgonLayer.ts:44

setRotation

setRotation(angle): NgonLayer
Parameters
- angle: number
  The angle of rotation the layer
Returns NgonLayer
Inherited from BaseLayer.setRotation
- Defined in structures/BaseLayer.ts:182

setShadowBlur

setShadowBlur(blur): NgonLayer
Parameters
- blur: number
  The degree of shadow blur
Returns NgonLayer
Inherited from BaseLayer.setShadowBlur
- Defined in structures/BaseLayer.ts:141

setShadowColor

setShadowColor(color): NgonLayer
Parameters
- color: string | Gradient | Pattern
  The shadow color for the layer
Returns NgonLayer
Inherited from BaseLayer.setShadowColor
- Defined in structures/BaseLayer.ts:131

setShadowOffsetX

setShadowOffsetX(offsetX): NgonLayer
Parameters
- offsetX: number
  The X-axis offset of the shadow relative to the layer
Returns NgonLayer
Inherited from BaseLayer.setShadowOffsetX
- Defined in structures/BaseLayer.ts:151

setShadowOffsetY

setShadowOffsetY(offsetY): NgonLayer
Parameters
- offsetY: number
  The Y-axis offset of the shadow relative to the layer
Returns NgonLayer
Inherited from BaseLayer.setShadowOffsetY
- Defined in structures/BaseLayer.ts:161

setSides

setSides(sides): NgonLayer
Parameters
- sides: number
  The number of sides the figure should have
Returns NgonLayer
- Defined in structures/NgonLayer.ts:34

setStroke

setStroke(stroke): NgonLayer
Parameters
- stroke: number
  The stroke of the figure
Returns NgonLayer
- Defined in structures/NgonLayer.ts:62

setX

setX(x): NgonLayer
Parameters
- x: number
  The x position of the layer
Returns NgonLayer
Inherited from BaseLayer.setX
- Defined in structures/BaseLayer.ts:111

setY

setY(y): NgonLayer
Parameters
- y: number
  The y position of the layer
Returns NgonLayer
Inherited from BaseLayer.setY
- Defined in structures/BaseLayer.ts:121

toJSON

toJSON(): {
    align:
        | "left"
        | "center"
        | "right"
        | "start"
        | "end";
    alpha: number;
    angle: number;
    angles: number[];
    baseline:
        | "alphabetic"
        | "top"
        | "hanging"
        | "middle"
        | "ideographic"
        | "bottom";
    centering: "legacy" | "new";
    clockwise: boolean;
    color: string | Gradient | Pattern;
    controlPoint: {
        x: number;
        y: number;
    };
    controlPoints: {
        x: number;
        y: number;
    }[];
    direction: "ltr" | "rtl" | "inherit";
    fill: boolean;
    filter: Filter;
    font: string;
    globalComposite:
        | "color"
        | "source-over"
        | "source-in"
        | "source-out"
        | "source-atop"
        | "destination-over"
        | "destination-in"
        | "destination-out"
        | "destination-atop"
        | "lighter"
        | "copy"
        | "xor"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "color-dodge"
        | "color-burn"
        | "hard-light"
        | "soft-light"
        | "difference"
        | "exclusion"
        | "hue"
        | "saturation"
        | "luminosity";
    height: number;
    image: string | Uint8Array;
    lineDash: number[];
    multiline: boolean;
    outline: LazyCanvasOutline;
    points: {
        x: number;
        y: number;
    }[];
    radius: number;
    rotation: number;
    shadow: {
        shadowBlur: number;
        shadowColor: string | Gradient | Pattern;
        shadowOffsetX: number;
        shadowOffsetY: number;
    };
    sides: number;
    size: number;
    stroke: number;
    structureType: string;
    text: string;
    type: string;
    weight:
        | "normal"
        | "bold"
        | "italic"
        | "bold italic"
        | "regular"
        | "semi-bold"
        | "extra-bold"
        | "light"
        | "extra-light";
    width: number;
    x: number;
    y: number;
    toJSON(): LazyCanvasLayer;
}
Returns {
    align:
        | "left"
        | "center"
        | "right"
        | "start"
        | "end";
    alpha: number;
    angle: number;
    angles: number[];
    baseline:
        | "alphabetic"
        | "top"
        | "hanging"
        | "middle"
        | "ideographic"
        | "bottom";
    centering: "legacy" | "new";
    clockwise: boolean;
    color: string | Gradient | Pattern;
    controlPoint: {
        x: number;
        y: number;
    };
    controlPoints: {
        x: number;
        y: number;
    }[];
    direction: "ltr" | "rtl" | "inherit";
    fill: boolean;
    filter: Filter;
    font: string;
    globalComposite:
        | "color"
        | "source-over"
        | "source-in"
        | "source-out"
        | "source-atop"
        | "destination-over"
        | "destination-in"
        | "destination-out"
        | "destination-atop"
        | "lighter"
        | "copy"
        | "xor"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "color-dodge"
        | "color-burn"
        | "hard-light"
        | "soft-light"
        | "difference"
        | "exclusion"
        | "hue"
        | "saturation"
        | "luminosity";
    height: number;
    image: string | Uint8Array;
    lineDash: number[];
    multiline: boolean;
    outline: LazyCanvasOutline;
    points: {
        x: number;
        y: number;
    }[];
    radius: number;
    rotation: number;
    shadow: {
        shadowBlur: number;
        shadowColor: string | Gradient | Pattern;
        shadowOffsetX: number;
        shadowOffsetY: number;
    };
    sides: number;
    size: number;
    stroke: number;
    structureType: string;
    text: string;
    type: string;
    weight:
        | "normal"
        | "bold"
        | "italic"
        | "bold italic"
        | "regular"
        | "semi-bold"
        | "extra-bold"
        | "light"
        | "extra-light";
    width: number;
    x: number;
    y: number;
    toJSON(): LazyCanvasLayer;
}
- align:
      | "left"
      | "center"
      | "right"
      | "start"
      | "end"
- alpha: number
- angle: number
- angles: number[]
- baseline:
      | "alphabetic"
      | "top"
      | "hanging"
      | "middle"
      | "ideographic"
      | "bottom"
- centering: "legacy" | "new"
- clockwise: boolean
- color: string | Gradient | Pattern
- controlPoint: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- controlPoints: {
  x: number;
  y: number;
  }[]
- direction: "ltr" | "rtl" | "inherit"
- fill: boolean
- filter: Filter
- font: string
- globalComposite:
      | "color"
      | "source-over"
      | "source-in"
      | "source-out"
      | "source-atop"
      | "destination-over"
      | "destination-in"
      | "destination-out"
      | "destination-atop"
      | "lighter"
      | "copy"
      | "xor"
      | "multiply"
      | "screen"
      | "overlay"
      | "darken"
      | "lighten"
      | "color-dodge"
      | "color-burn"
      | "hard-light"
      | "soft-light"
      | "difference"
      | "exclusion"
      | "hue"
      | "saturation"
      | "luminosity"
- height: number
- image: string | Uint8Array
- lineDash: number[]
- multiline: boolean
- outline: LazyCanvasOutline
- points: {
  x: number;
  y: number;
  }[]
- radius: number
- rotation: number
- shadow: {
      shadowBlur: number;
      shadowColor: string | Gradient | Pattern;
      shadowOffsetX: number;
      shadowOffsetY: number;
  }
  - shadowBlur: number
  - shadowColor: string | Gradient | Pattern
  - shadowOffsetX: number
  - shadowOffsetY: number
- sides: number
- size: number
- stroke: number
- structureType: string
- text: string
- type: string
- weight:
      | "normal"
      | "bold"
      | "italic"
      | "bold italic"
      | "regular"
      | "semi-bold"
      | "extra-bold"
      | "light"
      | "extra-light"
- width: number
- x: number
- y: number
- toJSON:function
  - toJSON(): LazyCanvasLayer
  - Returns LazyCanvasLayer
    - Defined in types/LazyCanvasLayer.d.ts:17
Inherited from BaseLayer.toJSON
- Defined in structures/BaseLayer.ts:198

Class NgonLayer

Example

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NgonLayer

Properties

data

Methods

setAlpha

Parameters

Returns NgonLayer

setColor

Parameters

Returns NgonLayer

setFilled

Parameters

Returns NgonLayer

setGlobalCompositeOperation

Parameters

Returns NgonLayer

setOutline

Parameters

Returns NgonLayer

setRadius

Parameters

Returns NgonLayer

setRotation

Parameters

Returns NgonLayer

setShadowBlur

Parameters

Returns NgonLayer

setShadowColor

Parameters

Returns NgonLayer

setShadowOffsetX

Parameters

Returns NgonLayer

setShadowOffsetY

Parameters

Returns NgonLayer

setSides

Parameters

Returns NgonLayer

setStroke

Parameters

Returns NgonLayer

setX

Parameters

Returns NgonLayer

setY

Parameters

Returns NgonLayer

toJSON

align: | "left" | "center" | "right" | "start" | "end"

alpha: number

angle: number

angles: number[]

baseline: | "alphabetic" | "top" | "hanging" | "middle" | "ideographic" | "bottom"

centering: "legacy" | "new"

clockwise: boolean

color: string | Gradient | Pattern

controlPoint: { x: number; y: number; }

x: number

y: number

controlPoints: { x: number; y: number; }[]

direction: "ltr" | "rtl" | "inherit"

fill: boolean

filter: Filter

font: string

height: number

image: string | Uint8Array

lineDash: number[]

multiline: boolean

align:
| "left"
| "center"
| "right"
| "start"
| "end"

baseline:
| "alphabetic"
| "top"
| "hanging"
| "middle"
| "ideographic"
| "bottom"

controlPoint: {
x: number;
y: number;
}

controlPoints: {
x: number;
y: number;
}[]

points: {
x: number;
y: number;
}[]

shadow: {
shadowBlur: number;
shadowColor: string | Gradient | Pattern;
shadowOffsetX: number;
shadowOffsetY: number;
}

weight:
| "normal"
| "bold"
| "italic"
| "bold italic"
| "regular"
| "semi-bold"
| "extra-bold"
| "light"
| "extra-light"