Class SVGLinGradient

Hierarchy

SVGGradient
- SVGLinGradient

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new SVGLinGradient(stops: SVGStops): SVGLinGradient

Overrides SVGGradient.constructor
- Defined in helpers/Gradient.ts:194
Create a Linear Gradient with stops

Parameters
- stops: SVGStops
  
  Stops of the gradient
Returns SVGLinGradient

Accessors

attributes

get attributes(): AttributeMap

Inherited from SVGAnimate.attributes
- Defined in SVGNode.ts:89
Fetch the current attributes

Returns AttributeMap

children

get children(): SVGNode[]

Inherited from SVGAnimate.children
- Defined in SVGNode.ts:84
Fetch the current children

Returns SVGNode[]

events

get events(): SVGManagerEventDefinition[]

Inherited from SVGAnimate.events
- Defined in SVGNode.ts:104
Fetch the events defined on the node

Returns SVGManagerEventDefinition[]

innerText

get innerText(): string

Inherited from SVGAnimate.innerText
- Defined in SVGNode.ts:99
Fetch the innerText of the node

Returns string

tagName

get tagName(): SVGTag

Inherited from SVGAnimate.tagName
- Defined in SVGNode.ts:94
Fetch the tagName of the node

Returns SVGTag

tags

get tags(): string[]

Inherited from SVGAnimate.tags
- Defined in SVGNode.ts:109
Fetch the tags set on the node

Returns string[]

Methods

animate

animate(svganimate: SVGAnimate): this

Inherited from SVGAnimate.animate
- Defined in SVGNode.ts:391
Animates the node using an SVGAnimate object

Parameters
- svganimate: SVGAnimate
Returns this

append

append(child: SVGNode): this

Inherited from SVGAnimate.append
- Defined in SVGNode.ts:224
Mutates the SVGNode to append an child SVGNode child to the children of the current SVGNode. Then, it returns itself, for easy programming.

Parameters
- child: SVGNode
Returns this

class

class(className: string): this

Inherited from SVGAnimate.class
- Defined in SVGNode.ts:252
Adds a class to a SVGNode

Parameters
- className: string
Returns this

clearEvents

clearEvents(eventName?: SVGEventName): this

Inherited from SVGAnimate.clearEvents
- Defined in SVGNode.ts:374
Remove either all events from 1 SVGEventName, or all if not given a name

Parameters
- Optional eventName: SVGEventName
Returns this

copy

copy(): SVGNode

Inherited from SVGAnimate.copy
- Defined in SVGNode.ts:262
Creates a deepcopy from current SVGNode

Returns SVGNode

cx

cx(val: AttributeValue): this

Inherited from SVGAnimate.cx
- Defined in SVGNode.ts:170
Setter for the cx attribute

Parameters
- val: AttributeValue
Returns this

cy

cy(val: AttributeValue): this

Inherited from SVGAnimate.cy
- Defined in SVGNode.ts:175
Setter for the cy attribute

Parameters
- val: AttributeValue
Returns this

equals

equals(node: SVGNode): boolean

Inherited from SVGAnimate.equals
- Defined in SVGNode.ts:274
Checks deeply whether two nodes are equal

Parameters
- node: SVGNode
Returns boolean

fill

fill(color: AttributeValue, opacity?: AttributeValue): this

Inherited from SVGAnimate.fill
- Defined in SVGNode.ts:143
Shortcut for setting fill attributes

Parameters
- color: AttributeValue
- Optional opacity: AttributeValue
Returns this

fillDef

fillDef(definition: SVGManagerDefinition, opacity?: AttributeValue): this

Inherited from SVGAnimate.fillDef
- Defined in SVGNode.ts:152
Shortcut for setting fill attributes to a definition (See more at SVGManager.define)

Parameters
- definition: SVGManagerDefinition
- Optional opacity: AttributeValue
Returns this

get

get(attr: SVGAttribute): AttributeValue | undefined

Inherited from SVGAnimate.get
- Defined in SVGNode.ts:195
Fetch a specific attribute's value

Parameters
- attr: SVGAttribute
Returns AttributeValue | undefined

gradientTransform

gradientTransform(value: AttributeValue): this

Inherited from SVGGradient.gradientTransform
- Defined in helpers/Gradient.ts:133
Set the gradientTransform attribute of the Gradient

Parameters
- value: AttributeValue
  
  Transformation
Returns this

gradientUnits

gradientUnits(value: "userSpaceOnUse" | "objectBoundingBox"): this

Inherited from SVGGradient.gradientUnits
- Defined in helpers/Gradient.ts:124
Set the gradientUnits attribute of the Gradient

Parameters
- value: "userSpaceOnUse" | "objectBoundingBox"
  
  Either 'userSpaceOnUse' or 'objectBoundingBox'
Returns this

href

href(value: AttributeValue): this

Inherited from SVGGradient.href
- Defined in helpers/Gradient.ts:142
Set the href attribute of the Gradient

Parameters
- value: AttributeValue
  
  Value of href
Returns this

map

map(attr: SVGAttribute, f: (_value: AttributeValue) => AttributeValue): SVGNode

Inherited from SVGAnimate.map
- Defined in SVGNode.ts:207
Mutates the SVGNode to change an attribute attr by putting its value through the function f. Then, it returns itself, for easy programming.

Note

If the attribute was not set, the call still succeeds but does nothing.

Parameters
- attr: SVGAttribute
- f: (_value: AttributeValue) => AttributeValue
  - - (_value: AttributeValue): AttributeValue
    - Parameters
      - _value: AttributeValue
      Returns AttributeValue
Returns SVGNode

on

on(eventName: SVGEventName, func: SVGManagerEventHandler): this

Inherited from SVGAnimate.on
- Defined in SVGNode.ts:235
Mutates the SVGNode to add an event. Multiple functions can be set for the same event. Then, it returns itself, for easy programming.

Parameters
- eventName: SVGEventName
- func: SVGManagerEventHandler
Returns this

r

r(radius: AttributeValue): this

Inherited from SVGAnimate.r
- Defined in SVGNode.ts:180
Setter for the r attribute

Parameters
- radius: AttributeValue
Returns this

removeChild

removeChild(index: number): this

Inherited from SVGAnimate.removeChild
- Defined in SVGNode.ts:354
Remove child at certain index

Parameters
- index: number
Returns this

removeChildren

removeChildren(): this

Inherited from SVGAnimate.removeChildren
- Defined in SVGNode.ts:367
Remove all children

Returns this

set

set(attr: SVGAttribute, value: AttributeValue): this

Inherited from SVGAnimate.set
- Defined in SVGNode.ts:188
Mutates the SVGNode to add/change an attribute attr to value. Then, it returns itself, for easy programming.

Parameters
- attr: SVGAttribute
- value: AttributeValue
Returns this

shallowEquals

shallowEquals(node: SVGNode): boolean

Inherited from SVGAnimate.shallowEquals
- Defined in SVGNode.ts:345
Checks shallowly whether two nodes are equal

Parameters
- node: SVGNode
Returns boolean

spreadMethod

spreadMethod(value: "pad" | "reflect" | "repeat"): this

Inherited from SVGGradient.spreadMethod
- Defined in helpers/Gradient.ts:151
Set the spreadMethod attribute of the Gradient

Parameters
- value: "pad" | "reflect" | "repeat"
  
  Either 'pad', 'reflect' or 'repeat'
Returns this

stroke

stroke(color: AttributeValue, width?: AttributeValue, opacity?: AttributeValue): this

Inherited from SVGAnimate.stroke
- Defined in SVGNode.ts:120
Shortcut for setting stroke attributes

Parameters
- color: AttributeValue
- Optional width: AttributeValue
- Optional opacity: AttributeValue
Returns this

strokeDef

strokeDef(definition: SVGManagerDefinition, width?: AttributeValue, opacity?: AttributeValue): this

Inherited from SVGAnimate.strokeDef
- Defined in SVGNode.ts:134
Shortcut for setting stroke attributes to a definition (See more at SVGManager.define)

Parameters
- definition: SVGManagerDefinition
- Optional width: AttributeValue
- Optional opacity: AttributeValue
Returns this

tag

tag(tag: string): this

Inherited from SVGAnimate.tag
- Defined in SVGNode.ts:245
Give tag to the SVGNode to mention later

Parameters
- tag: string
  
  Tag given to SVGNode
Returns this

text

text(s: string): this

Inherited from SVGAnimate.text
- Defined in SVGNode.ts:114
Sets the innerText of the node

Parameters
- s: string
Returns this

toHTML

toHTML(): SVGElement

Inherited from SVGAnimate.toHTML
- Defined in SVGNode.ts:399
Returns the JS SVGElement equavalent of current SVGNode

Returns SVGElement

toHash

toHash(): string

Inherited from SVGAnimate.toHash
- Defined in SVGNode.ts:434
Returns the hashstring of SVGNode

Returns string

untag

untag(tag: string): this

Inherited from SVGAnimate.untag
- Defined in SVGNode.ts:385
Removes tag from node, if it does not exist it does nothing.

Parameters
- tag: string
Returns this

x

x(val: AttributeValue): this

Inherited from SVGAnimate.x
- Defined in SVGNode.ts:160
Setter for the x attribute

Parameters
- val: AttributeValue
Returns this

x1

x1(length: AttributeValue): this

- Defined in helpers/Gradient.ts:207
Set the x1 attribute of the Linear Gradient

Parameters
- length: AttributeValue
  
  Length from 0-1
Returns this

x2

x2(length: AttributeValue): this

- Defined in helpers/Gradient.ts:216
Set the x2 attribute of the Linear Gradient

Parameters
- length: AttributeValue
  
  Length from 0-1
Returns this

y

y(val: AttributeValue): this

Inherited from SVGAnimate.y
- Defined in SVGNode.ts:165
Setter for the y attribute

Parameters
- val: AttributeValue
Returns this

y1

y1(length: AttributeValue): this

- Defined in helpers/Gradient.ts:225
Set the y1 attribute of the Linear Gradient

Parameters
- length: AttributeValue
  
  Length from 0-1
Returns this

y2

y2(length: AttributeValue): this

- Defined in helpers/Gradient.ts:234
Set the y2 attribute of the Linear Gradient

Parameters
- length: AttributeValue
  
  Length from 0-1
Returns this

Generated using TypeDoc