Class Mask

Hierarchy

AbstractNonRenderable<SVGMaskElement, Mask_Attributes>
- Mask

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Mask(context: Context, w?: undefined | number, h?: undefined | number, x?: undefined | number, y?: undefined | number, units?: "userSpaceOnUse" | "objectBoundingBox", contentUnits?: "userSpaceOnUse" | "objectBoundingBox"): Mask

Overrides Element.constructor
- Defined in elements/non-renderables/mask.ts:26
Parameters
- context: Context
- Optional w: undefined | number
- Optional h: undefined | number
- Optional x: undefined | number
- Optional y: undefined | number
- Optional units: "userSpaceOnUse" | "objectBoundingBox"
- Optional contentUnits: "userSpaceOnUse" | "objectBoundingBox"
Returns Mask

Properties

Protected _node

_node: SVGMaskElement

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(): SVGMaskElement

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

Methods

add

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

Inherited from Element.add
- Defined in element.ts:140
Parameters
- el: Element<SVGElement> | SVGElement
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 Mask_Attributes
Parameters
- name: Attr
- val: ATTRIBUTES[Attr]
- duration: number
- easing: EasingFunction
Returns Promise<number> | undefined

clone

clone(deep?: boolean, id?: string): Element<SVGMaskElement, Mask_Attributes, NonRenderable_Events>

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

Protected cloneNode

cloneNode(deep?: boolean): SVGMaskElement

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

copyStyleFrom

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

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

destroy

destroy(): void

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

flush

flush(): Promise<number>

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

getAttribute

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

Inherited from Element.getAttribute
- Defined in element.ts:97
Type parameters
- Attr: keyof Mask_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 NonRenderable_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>

linkDynamicAttribute

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

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

renderAttribute

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

Inherited from Element.renderAttribute
- Defined in element.ts:50
Type parameters
- Attr: keyof Mask_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 Mask_Attributes
Parameters
- name: Attr
- val: ATTRIBUTES[Attr]
Returns void

setAttributes

setAttributes(attrs: Partial<Mask_Attributes>): void

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

toString

toString(): string

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

Generated using TypeDoc