Class GraphicEngine Abstract

Hierarchy

Collection
- GraphicEngine

Index

Constructors

constructor

Properties

Accessors Collection

length

Methods CSS class

Methods Collection

Methods Dimensions

Methods Events

Methods HTML manipulation

Methods Other

Methods Traversing

Constructors

constructor

new GraphicEngine(selector: Selector, options?: GraphicEngineOptions): GraphicEngine

Overrides Collection.constructor
- Defined in GraphicEngine.ts:26
selector can be:
- a string containing a CSS query
- a single Elem
- an array of Elem
Parameters
- selector: Selector
- Optional options: GraphicEngineOptions
Returns GraphicEngine

Properties

Protected Readonly elements

elements: Elem[] = []

Protected framecount

framecount: number = 0

Protected options

options: GraphicEngineOptions

Collection Accessors

length

get length(): number

Inherited from Collection.length
- Defined in Collection/Core.ts:48
Return the number of Elem in the collection

category
Collection

Returns number

CSS class Methods

addClass

addClass(classNames: string): GraphicEngine

Inherited from Collection.addClass
- Defined in Collection/CSS.ts:30
Add the given classNames to all Elem

Parameters
- classNames: string
Returns GraphicEngine

hasClass

hasClass(className: string): boolean

Inherited from Collection.hasClass
- Defined in Collection/CSS.ts:15
Return true if any Elem has the given class

Parameters
- className: string
Returns boolean

removeClass

removeClass(classNames: string): GraphicEngine

Inherited from Collection.removeClass
- Defined in Collection/CSS.ts:45
Remove the given classNames to all Elem

Parameters
- classNames: string
Returns GraphicEngine

toggleClass

toggleClass(classNames: string): GraphicEngine

Inherited from Collection.toggleClass
- Defined in Collection/CSS.ts:60
Toggle the given classNames to all Elem

Parameters
- classNames: string
Returns GraphicEngine

Collection Methods

add

add(newItem: Elem): void

Inherited from Collection.add
- Defined in Collection/Core.ts:99
Add an Elem to the collection

Parameters
- newItem: Elem
Returns void

each

each(callback: Function): GraphicEngine

Inherited from Collection.each
- Defined in Collection/Core.ts:66
In contrary of forEach this function return each Elem as Collection.

Parameters
- callback: Function
Returns GraphicEngine

eq

eq(index: number): Collection

Inherited from Collection.eq
- Defined in Collection/Core.ts:90
Return a new collection containing element at the specified index.

Parameters
- index: number
  
  Index of the element in the collection
Returns Collection

forEach

forEach(callback: ((value: Elem, index: number, array: Elem[]) => void), thisArg?: any): void

Inherited from Collection.forEach
- Defined in Collection/Core.ts:57
Execute a callback on every Elem

Parameters
- callback: ((value: Elem, index: number, array: Elem[]) => void)
  - - (value: Elem, index: number, array: Elem[]): void
    - Parameters
      - value: Elem
      - index: number
      - array: Elem[]
      Returns void
- Optional thisArg: any
Returns void

get

get(index: number): Elem

Inherited from Collection.get
- Defined in Collection/Core.ts:79
Return collection's Elem or a single Elem

Parameters
- index: number
  
  Index of the element in the collection
Returns Elem

search

search(selector: string): Collection

Inherited from Collection.search
- Defined in Collection/Core.ts:116
Search for a specific Elem in the collection

Parameters
- selector: string
  
  A css selector to search
Returns Collection

Dimensions Methods

height

height(): number
height(value: number): GraphicEngine
height(value: string): GraphicEngine

Inherited from Collection.height
- Defined in Collection/Dimensions.ts:40
Get or set the height of an element in pixels

Returns number
Inherited from Collection.height
- Defined in Collection/Dimensions.ts:41
Parameters
- value: number
Returns GraphicEngine
Inherited from Collection.height
- Defined in Collection/Dimensions.ts:42
Parameters
- value: string
Returns GraphicEngine

position

position(target?: string | Collection): Point

Inherited from Collection.position
- Defined in Collection/Dimensions.ts:64
Return element position relative to other element or document

Parameters
- Optional target: string | Collection
Returns Point

viewportPosition

viewportPosition(): Point

Inherited from Collection.viewportPosition
- Defined in Collection/Dimensions.ts:85
Return element position in viewport

Returns Point

width

width(): number
width(value: number): GraphicEngine
width(value: string): GraphicEngine

Inherited from Collection.width
- Defined in Collection/Dimensions.ts:16
Get or set the width of an element in pixels

Returns number
Inherited from Collection.width
- Defined in Collection/Dimensions.ts:17
Parameters
- value: number
Returns GraphicEngine
Inherited from Collection.width
- Defined in Collection/Dimensions.ts:18
Parameters
- value: string
Returns GraphicEngine

Events Methods

off

off(eventNames: string | string[], selector?: string): Collection

Inherited from Collection.off
- Defined in Collection/Events.ts:39
Remove an event handler function for one or more events to the selected elements.

Parameters
- eventNames: string | string[]
- Optional selector: string
Returns Collection

on

on(eventNames: string | string[], callback: EventCallback, useCapture?: boolean): Collection
on(eventNames: string | string[], selector: Selector, callback: EventCallback, useCapture?: boolean): Collection

Inherited from Collection.on
- Defined in Collection/Events.ts:17
Attach an event handler function for one or more events to the selected elements.

Parameters
- eventNames: string | string[]
- callback: EventCallback
- Optional useCapture: boolean
Returns Collection
Inherited from Collection.on
- Defined in Collection/Events.ts:18
Parameters
- eventNames: string | string[]
- selector: Selector
- callback: EventCallback
- Optional useCapture: boolean
Returns Collection

trigger

trigger(eventName: string): Collection

Inherited from Collection.trigger
- Defined in Collection/Events.ts:56
Trigger an event handler function for one or more events to the selected elements.

Parameters
- eventName: string
Returns Collection

HTML manipulation Methods

after

after(itemsArray: Collection | Collection[]): GraphicEngine

Inherited from Collection.after
- Defined in Collection/HTML.ts:118
Add an element after specified element

Parameters
- itemsArray: Collection | Collection[]
Returns GraphicEngine

append

append(itemsArray: Collection | Collection[]): GraphicEngine

Inherited from Collection.append
- Defined in Collection/HTML.ts:80
Insert content, specified by the parameter, to the end of each element in the collection

Parameters
- itemsArray: Collection | Collection[]
Returns GraphicEngine

attr

attr(name: string): string
attr(name: string, value: any): GraphicEngine

Inherited from Collection.attr
- Defined in Collection/HTML.ts:224
Get the value of an attribute for the first element in the set of matched elements or set one attribute for every matched element.

Parameters
- name: string
Returns string
Inherited from Collection.attr
- Defined in Collection/HTML.ts:225
Parameters
- name: string
- value: any
Returns GraphicEngine

before

before(itemsArray: Collection | Collection[]): GraphicEngine

Inherited from Collection.before
- Defined in Collection/HTML.ts:98
Add an element before specified element

Parameters
- itemsArray: Collection | Collection[]
Returns GraphicEngine

clone

clone(): Collection

Inherited from Collection.clone
- Defined in Collection/HTML.ts:45
Return a clone of the collection

Returns Collection

css

css(name: string): string
css(name: {}): GraphicEngine
css(name: string, value?: string | number, priority?: "" | "important"): GraphicEngine

Inherited from Collection.css
- Defined in Collection/CSS.ts:78
Get the value of a css property for the first element in the set of matched elements or set css properties for every matched element.

Parameters
- name: string
Returns string
Inherited from Collection.css
- Defined in Collection/CSS.ts:79
Parameters
- name: {}
  - [property: string]: string | number
Returns GraphicEngine
Inherited from Collection.css
- Defined in Collection/CSS.ts:80
Parameters
- name: string
- Optional value: string | number
- Optional priority: "" | "important"
Returns GraphicEngine

data

data(name: string): string
data(name: string, value: any): GraphicEngine

Inherited from Collection.data
- Defined in Collection/HTML.ts:259
Get the value of a data attribute for the first element in the set of matched elements or set one data attribute for every matched element.

Parameters
- name: string
Returns string
Inherited from Collection.data
- Defined in Collection/HTML.ts:260
Parameters
- name: string
- value: any
Returns GraphicEngine

empty

empty(): GraphicEngine

Inherited from Collection.empty
- Defined in Collection/HTML.ts:30
Clear all DOM children of the Elem

Returns GraphicEngine

html

html(): string
html(value: string | number): GraphicEngine
html(value: string | number, append?: boolean): GraphicEngine

Inherited from Collection.html
- Defined in Collection/HTML.ts:177
Set the innerHTML of the first element in the collection of set the innerHTML of all elements in the collection.

Returns string
Inherited from Collection.html
- Defined in Collection/HTML.ts:178
Parameters
- value: string | number
Returns GraphicEngine
Inherited from Collection.html
- Defined in Collection/HTML.ts:179
Parameters
- value: string | number
- Optional append: boolean
Returns GraphicEngine

prepend

prepend(itemsArray: Collection | Collection[]): GraphicEngine

Inherited from Collection.prepend
- Defined in Collection/HTML.ts:61
Insert content, specified by the parameter, to the beginning of each element in the collection

Parameters
- itemsArray: Collection | Collection[]
Returns GraphicEngine

remove

remove(): GraphicEngine

Inherited from Collection.remove
- Defined in Collection/HTML.ts:16
Remove the Elem for the DOM.

Returns GraphicEngine

removeAttr

removeAttr(name: string): Collection

Inherited from Collection.removeAttr
- Defined in Collection/HTML.ts:245
Remove an attribute on each element in the set.

Parameters
- name: string
Returns Collection

text

text(): string
text(value: string | number): GraphicEngine

Inherited from Collection.text
- Defined in Collection/HTML.ts:203
Set the text of the first element in the collection of set the text of all elements in the collection.

Returns string
Inherited from Collection.text
- Defined in Collection/HTML.ts:204
Parameters
- value: string | number
Returns GraphicEngine

val

val(): string
val(value: string | number): GraphicEngine

Inherited from Collection.val
- Defined in Collection/HTML.ts:156
Set the value of the first element in the collection of set the value of all elements in the collection.

Returns string
Inherited from Collection.val
- Defined in Collection/HTML.ts:157
Parameters
- value: string | number
Returns GraphicEngine

wrap

wrap(wrapper: Collection): GraphicEngine

Inherited from Collection.wrap
- Defined in Collection/HTML.ts:139
Wrap each element in the collection with specified element

Parameters
- wrapper: Collection
Returns GraphicEngine

Other Methods

animate

animate(): void

- Defined in GraphicEngine.ts:72
Returns void

Protected clear

clear(): void

- Defined in GraphicEngine.ts:70
Returns void

draw

draw(): void

- Defined in GraphicEngine.ts:74
Returns void

Protected render

render(): void

- Defined in GraphicEngine.ts:76
Returns void

Private requestAnimationFrame

requestAnimationFrame(): void

- Defined in GraphicEngine.ts:38
Returns void

resize

resize(dimensions?: Dimensions): void

- Defined in GraphicEngine.ts:53
Parameters
- Optional dimensions: Dimensions
Returns void

setup

setup(): void

- Defined in GraphicEngine.ts:68
Returns void

Traversing Methods

children

children(selector?: string): Collection

Inherited from Collection.children
- Defined in Collection/Traversing.ts:164
Get direct children

Parameters
- Optional selector: string
  
  A css selector
Returns Collection
Collection

find

find(selector: string): Collection

Inherited from Collection.find
- Defined in Collection/Traversing.ts:185
Search of children matching the selector

Parameters
- selector: string
  
  A css selector
Returns Collection
Collection

first

first(): Collection

Inherited from Collection.first
- Defined in Collection/Traversing.ts:104
Return the first element in collection

Returns Collection
Collection

index

index(): number

Inherited from Collection.index
- Defined in Collection/Traversing.ts:205
Return the position of the first element within the Collection relative to its sibling elements

Returns number
number

last

last(): Collection

Inherited from Collection.last
- Defined in Collection/Traversing.ts:114
Return the last element in collection

Returns Collection
Collection

next

next(selector?: string): Collection

Inherited from Collection.next
- Defined in Collection/Traversing.ts:67
Return the next element for each Elem in the collection

Parameters
- Optional selector: string
  
  A css selector
Returns Collection
Collection

nextAll

nextAll(selector?: string): Collection

Inherited from Collection.nextAll
- Defined in Collection/Traversing.ts:86
Return all next elements for each Elem in the collection

Parameters
- Optional selector: string
  
  A css selector
Returns Collection
Collection

parent

parent(selector?: string): Collection

Inherited from Collection.parent
- Defined in Collection/Traversing.ts:125
Return the parent element for each Elem in the collection

Parameters
- Optional selector: string
  
  A css selector
Returns Collection
Collection

parents

parents(selector?: string): Collection

Inherited from Collection.parents
- Defined in Collection/Traversing.ts:142
Search for a parent element matching the selector

Parameters
- Optional selector: string
  
  A css selector
Returns Collection
Collection

prev

prev(selector?: string): Collection

Inherited from Collection.prev
- Defined in Collection/Traversing.ts:29
Return the previous element for each Elem in the collection

Parameters
- Optional selector: string
  
  A css selector
Returns Collection
Collection

prevAll

prevAll(selector?: string): Collection

Inherited from Collection.prevAll
- Defined in Collection/Traversing.ts:48
Return all previous elements for each Elem in the collection

Parameters
- Optional selector: string
  
  A css selector
Returns Collection
Collection

Generated using TypeDoc