Class Filter

Hierarchy

Element<SVGFilterElement, Filter_Attributes, Filter_Events>
- Filter

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Filter(context: Context): Filter

Overrides Element.constructor
- Defined in elements/filter.ts:62
Parameters
- context: Context
Returns Filter

Properties

Protected _node

_node: SVGFilterElement

Private _refCounter

_refCounter: number = 0

Protected _style

_style: CSSStyleDeclaration

context

context: Context

Accessors

boundingBox

get boundingBox(): Box

Inherited from Element.boundingBox
- Defined in element.ts:136
Returns Box

id

get id(): string

Inherited from Element.id
- Defined in element.ts:41
Returns string

node

get node(): SVGFilterElement

Inherited from Element.node
- Defined in element.ts:44
Returns SVGFilterElement

Methods

add

add(el: Element<SVGElement> | SVGElement): void

Inherited from Element.add
- Defined in element.ts:140
Parameters
- el: Element<SVGElement> | SVGElement
Returns void

Private addLights

addLights(lighting: Element<SVGFEDiffuseLightingElement | SVGFESpecularLightingElement, FilterPrimitive_Attributes>, lights: LightSource_Attributes[]): void

- Defined in elements/filter.ts:181
Parameters
- lighting: Element<SVGFEDiffuseLightingElement | SVGFESpecularLightingElement, FilterPrimitive_Attributes>
- lights: LightSource_Attributes[]
Returns void

animateAttribute

animateAttribute<Attr>(name: Attr, val: ATTRIBUTES[Attr], duration: number, easing: EasingFunction): Promise<number> | undefined

Inherited from Element.animateAttribute
- Defined in element.ts:67
Type parameters
- Attr: keyof Filter_Attributes
Parameters
- name: Attr
- val: ATTRIBUTES[Attr]
- duration: number
- easing: EasingFunction
Returns Promise<number> | undefined

blend

blend(mode: "normal" | "multiply" | "screen" | "darken" | "lighten", input1: FilterInput, input2?: FilterInput): Blend_Primitive

- Defined in elements/filter.ts:70
Parameters
- mode: "normal" | "multiply" | "screen" | "darken" | "lighten"
- input1: FilterInput
- Optional input2: FilterInput
Returns Blend_Primitive

clone

clone(deep?: boolean, id?: string): Element<SVGFilterElement, Filter_Attributes, Filter_Events>

Inherited from Element.clone
- Defined in element.ts:156
Parameters
- Default value deep: boolean = true
- Default value id: string = randomShortStringId()
Returns Element<SVGFilterElement, Filter_Attributes, Filter_Events>

Protected cloneNode

cloneNode(deep?: boolean): SVGFilterElement

Inherited from Element.cloneNode
- Defined in element.ts:165
Parameters
- Default value deep: boolean = true
Returns SVGFilterElement

colorMatrix

colorMatrix(matrix: ColorMatrix, input?: FilterInput): ColorMatrix_Primitive

- Defined in elements/filter.ts:77
Parameters
- matrix: ColorMatrix
- Optional input: FilterInput
Returns ColorMatrix_Primitive

componentTransfer

componentTransfer(r: TransferFunction_Attributes, g: TransferFunction_Attributes, b: TransferFunction_Attributes, a?: TransferFunction_Attributes, input?: FilterInput): ComponentTransfer_Primitive

- Defined in elements/filter.ts:84
Parameters
- r: TransferFunction_Attributes
- g: TransferFunction_Attributes
- b: TransferFunction_Attributes
- Optional a: TransferFunction_Attributes
- Optional input: FilterInput
Returns ComponentTransfer_Primitive

composite

composite(operator: "over" | "in" | "out" | "atop" | "xor" | "arithmetic", k1: number, k2: number, k3: number, k4: number, input1?: FilterInput, input2?: FilterInput): Composite_Primitive

- Defined in elements/filter.ts:96
Parameters
- operator: "over" | "in" | "out" | "atop" | "xor" | "arithmetic"
- k1: number
- k2: number
- k3: number
- k4: number
- Optional input1: FilterInput
- Optional input2: FilterInput
Returns Composite_Primitive

convolveMatrix

convolveMatrix(attrs: Partial<ConvolveMatrix_Attributes>, input?: FilterInput): ConvolveMatrix_Primitive

- Defined in elements/filter.ts:107
Parameters
- attrs: Partial<ConvolveMatrix_Attributes>
- Optional input: FilterInput
Returns ConvolveMatrix_Primitive

copyStyleFrom

copyStyleFrom(el: Element<SVGElement, Filter_Attributes, any>): void
copyStyleFrom(el: Element<SVGElement, Filter_Attributes, any>, includeExclude: object, defaultInclude: boolean): void

Inherited from Element.copyStyleFrom
- Defined in element.ts:101
Parameters
- el: Element<SVGElement, Filter_Attributes, any>
Returns void
Inherited from Element.copyStyleFrom
- Defined in element.ts:102
Parameters
- el: Element<SVGElement, Filter_Attributes, any>
- includeExclude: object
- defaultInclude: boolean
Returns void

destroy

destroy(): void

Inherited from Element.destroy
- Defined in element.ts:162
Returns void

diffuseLighting

diffuseLighting(attrs: Partial<DiffuseLighting_Attributes>, lights?: LightSource_Attributes[], input?: FilterInput): DiffuseLighting

- Defined in elements/filter.ts:110
Parameters
- attrs: Partial<DiffuseLighting_Attributes>
- Default value lights: LightSource_Attributes[] = []
- Optional input: FilterInput
Returns DiffuseLighting

displacementMap

displacementMap(attrs: Partial<DisplacementMap_Attributes>, input1?: FilterInput, input2?: FilterInput): DisplacementMap_Primitive

- Defined in elements/filter.ts:115
Parameters
- attrs: Partial<DisplacementMap_Attributes>
- Optional input1: FilterInput
- Optional input2: FilterInput
Returns DisplacementMap_Primitive

flood

flood(color: Color, area: Box): Flood_Primitive

- Defined in elements/filter.ts:118
Parameters
- color: Color
- area: Box
Returns Flood_Primitive

flush

flush(): Promise<number>

Inherited from Element.flush
- Defined in element.ts:88
Returns Promise<number>

gaussianBlur

gaussianBlur(stdDeviation?: number, edgeMode?: "duplicate" | "wrap" | None, input?: FilterInput): GaussianBlur_Primitive

- Defined in elements/filter.ts:128
Parameters
- Default value stdDeviation: number = 0
- Default value edgeMode: "duplicate" | "wrap" | None = "duplicate"
- Optional input: FilterInput
Returns GaussianBlur_Primitive

getAttribute

getAttribute<Attr>(name: Attr): string | null

Inherited from Element.getAttribute
- Defined in element.ts:97
Type parameters
- Attr: keyof Filter_Attributes
Parameters
- name: Attr
Returns string | null

getChildren

getChildren(): Element<SVGElement>[]

Inherited from Element.getChildren
- Defined in element.ts:148
Returns Element<SVGElement>[]

getEvent

getEvent<EVENT>(event: EVENT): Observable<EVENTS[EVENT]>

Inherited from Element.getEvent
- Defined in element.ts:128
Type parameters
- EVENT: keyof Filter_Events
Parameters
- event: EVENT
Returns Observable<EVENTS[EVENT]>

getEvents

getEvents(...events: keyof EVENTS[]): Observable<Event>

Inherited from Element.getEvents
- Defined in element.ts:132
Parameters
- Rest ...events: keyof EVENTS[]
Returns Observable<Event>

getUniquePrimitiveReference

getUniquePrimitiveReference(): string

- Defined in elements/filter.ts:67
Returns string

image

image(href: string, preserveAspectRatio?: PreserveAspectRatio): Image_Primitive

- Defined in elements/filter.ts:135
Parameters
- href: string
- Optional preserveAspectRatio: PreserveAspectRatio
Returns Image_Primitive

linkDynamicAttribute

linkDynamicAttribute<Attr>(name: Attr, val: Observable<ATTRIBUTES[Attr]>): Subscription

Inherited from Element.linkDynamicAttribute
- Defined in element.ts:79
Type parameters
- Attr: keyof Filter_Attributes
Parameters
- name: Attr
- val: Observable<ATTRIBUTES[Attr]>
Returns Subscription

merge

merge(inputs: FilterInput[]): Merge_Primitive

- Defined in elements/filter.ts:141
Parameters
- inputs: FilterInput[]
Returns Merge_Primitive

morphology

morphology(operator: "erode" | "dilate", radius: NumberOptionalNumber, input?: FilterInput): Morphology_Primitive

- Defined in elements/filter.ts:149
Parameters
- operator: "erode" | "dilate"
- radius: NumberOptionalNumber
- Optional input: FilterInput
Returns Morphology_Primitive

offset

offset(d: Point, input?: FilterInput): Offset_Primitive

- Defined in elements/filter.ts:156
Parameters
- d: Point
- Optional input: FilterInput
Returns Offset_Primitive

renderAttribute

renderAttribute<Attr>(name: Attr, val: ATTRIBUTES[Attr]): void

Inherited from Element.renderAttribute
- Defined in element.ts:50
Type parameters
- Attr: keyof Filter_Attributes
Parameters
- name: Attr
- val: ATTRIBUTES[Attr]
Returns void

setAttribute

setAttribute<Attr>(name: Attr, val: ATTRIBUTES[Attr]): void

Inherited from Element.setAttribute
- Defined in element.ts:59
Type parameters
- Attr: keyof Filter_Attributes
Parameters
- name: Attr
- val: ATTRIBUTES[Attr]
Returns void

setAttributes

setAttributes(attrs: Partial<Filter_Attributes>): void

Inherited from Element.setAttributes
- Defined in element.ts:63
Parameters
- attrs: Partial<Filter_Attributes>
Returns void

specularLighting

specularLighting(attrs: Partial<SpecularLighting_Attributes>, lights?: LightSource_Attributes[]): SpecularLighting

- Defined in elements/filter.ts:163
Parameters
- attrs: Partial<SpecularLighting_Attributes>
- Default value lights: LightSource_Attributes[] = []
Returns SpecularLighting

tile

tile(area: Box, input?: FilterInput): Tile_Primitive

- Defined in elements/filter.ts:168
Parameters
- area: Box
- Optional input: FilterInput
Returns Tile_Primitive

toString

toString(): string

Inherited from Element.toString
- Defined in element.ts:47
Returns string

turbulence

turbulence(attrs: Partial<Turbulence_Attributes>): Turbulence_Primitive

- Defined in elements/filter.ts:178
Parameters
- attrs: Partial<Turbulence_Attributes>
Returns Turbulence_Primitive

Generated using TypeDoc