Class SVGStops

An easy way to create multiple stop elements

Basically an stack with the stop method to add a new stop

Hierarchy

SVGStops

Index

Constructors

constructor

Properties

_stops

Accessors

head

Methods

Constructors

constructor

new SVGStops(): SVGStops

- Defined in helpers/Gradient.ts:10
Creates an empty stack

Returns SVGStops

Properties

Private _stops

_stops: SVGNode[]

Accessors

head

get head(): SVGNode

- Defined in helpers/Gradient.ts:51
Turns the head to the stack

Returns SVGNode

Methods

copy

copy(): SVGStops

- Defined in helpers/Gradient.ts:99
Returns SVGStops

every

every(f: (node: SVGNode, index: number, array: SVGNode[]) => boolean): boolean

- Defined in helpers/Gradient.ts:87
Parameters
- f: (node: SVGNode, index: number, array: SVGNode[]) => boolean
  - - (node: SVGNode, index: number, array: SVGNode[]): boolean
    - Parameters
      - node: SVGNode
      - index: number
      - array: SVGNode[]
      Returns boolean
Returns boolean

forEach

forEach(f: (node: SVGNode, index: number, array: SVGNode[]) => void): void

- Defined in helpers/Gradient.ts:69
Execute f for every element in stack

Parameters
- f: (node: SVGNode, index: number, array: SVGNode[]) => void
  - - (node: SVGNode, index: number, array: SVGNode[]): void
    - Parameters
      - node: SVGNode
      - index: number
      - array: SVGNode[]
      Returns void
Returns void

map

map(f: (node: SVGNode, index: number, array: SVGNode[]) => SVGNode): this

- Defined in helpers/Gradient.ts:75
Parameters
- f: (node: SVGNode, index: number, array: SVGNode[]) => SVGNode
  - - (node: SVGNode, index: number, array: SVGNode[]): SVGNode
    - Parameters
      - node: SVGNode
      - index: number
      - array: SVGNode[]
      Returns SVGNode
Returns this

mapHead

mapHead(f: (node: SVGNode) => void): this

- Defined in helpers/Gradient.ts:42
Returns head

Parameters
- f: (node: SVGNode) => void
  - - (node: SVGNode): void
    - Parameters
      - node: SVGNode
      Returns void
Returns this

pop

pop(): this

- Defined in helpers/Gradient.ts:61
Pops head element of stack

Returns this

push

push(item: SVGNode): void

- Defined in helpers/Gradient.ts:83
Parameters
- item: SVGNode
Returns void

some

some(f: (node: SVGNode, index: number, array: SVGNode[]) => boolean): boolean

- Defined in helpers/Gradient.ts:93
Parameters
- f: (node: SVGNode, index: number, array: SVGNode[]) => boolean
  - - (node: SVGNode, index: number, array: SVGNode[]): boolean
    - Parameters
      - node: SVGNode
      - index: number
      - array: SVGNode[]
      Returns boolean
Returns boolean

stop

stop(offset: AttributeValue, stopColor?: AttributeValue, stopOpacity?: AttributeValue): this

- Defined in helpers/Gradient.ts:23
Create a gradient stop

Parameters
- offset: AttributeValue
  
  offset from 0-1 of the stop
- Optional stopColor: AttributeValue
  
  Optional color of the stop (default is black)
- Optional stopOpacity: AttributeValue
  
  Optional opacity from 0-1 of the stop (default is 1)
Returns this

Generated using TypeDoc