Index
- addCssClass
- addElement
- convertOldOptions
- createBrowserEvent
- domel
- getDocSize
- getElementAbsolutePos
- getScrollPos
- getViewportSize
- getWinSize
- hideElement
- isVisible
- renderPageNavigator
- showElement
- slideDown
- slideUp
- toggleVisibility
- wrapInner
addCssClass
Adds css class to the html element.
▸ addCssClass(element: HTMLElement,className: string): void
Parameters:
- element:
HTMLElement- The element to add css class to. - className:
string- The name of the css class to be added.
Returns void
addElement
Creates ands adds a new [[HTMLElement]] to "parent"
▸ addElement(parent: HTMLElement,tag: string,options?: any): HTMLElement
Parameters:
- parent:
HTMLElement- The element to add new element to. - tag:
string- Html tag of the new element. - options:
any, Optional - The options. In particular, options.cssClass sets the new element class.
Returns HTMLElement - New element.
convertOldOptions
Converts options from old 4.x format to [[EqViewOptions]]
▸ convertOldOptions(defaultOptions: EqViewOptions): EqViewOptions
Parameters:
- defaultOptions: EqViewOptions - The default [[EqViewOptions]] object to be extended by old options.
Returns EqViewOptions - Converted [[EqViewOptions]] object.
createBrowserEvent
▸ createBrowserEvent(eventName: any): any
Parameters:
- eventName:
any
Returns any
domel
▸ domel(tag: "div" | HTMLDivElement,parent?: HTMLElement): DomElementBuilder<HTMLDivElement>
Parameters:
- tag:
"div"|HTMLDivElement - parent:
HTMLElement, Optional
Returns DomElementBuilder<HTMLDivElement>
▸ domel(tag: "span" | HTMLSpanElement,parent?: HTMLElement): DomElementBuilder<HTMLSpanElement>
Parameters:
- tag:
"span"|HTMLSpanElement - parent:
HTMLElement, Optional
Returns DomElementBuilder<HTMLSpanElement>
▸ domel(tag: "a" | HTMLAnchorElement,parent?: HTMLElement): DomElementBuilder<HTMLAnchorElement>
Parameters:
- tag:
"a"|HTMLAnchorElement - parent:
HTMLElement, Optional
Returns DomElementBuilder<HTMLAnchorElement>
▸ domel(tag: "button" | HTMLButtonElement,parent?: HTMLElement): DomElementBuilder<HTMLButtonElement>
Parameters:
- tag:
"button"|HTMLButtonElement - parent:
HTMLElement, Optional
Returns DomElementBuilder<HTMLButtonElement>
▸ domel(tag: "img" | HTMLImageElement,parent?: HTMLElement): DomElementBuilder<HTMLImageElement>
Parameters:
- tag:
"img"|HTMLImageElement - parent:
HTMLElement, Optional
Returns DomElementBuilder<HTMLImageElement>
▸ domel(tag: "input" | HTMLInputElement,parent?: HTMLElement): DomInputElementBuilder
Parameters:
- tag:
"input"|HTMLInputElement - parent:
HTMLElement, Optional
Returns DomInputElementBuilder
▸ domel(tag: "dropdown",parent?: HTMLElement): DomDropDownElementBuilder
Parameters:
- tag:
"dropdown" - parent:
HTMLElement, Optional
Returns DomDropDownElementBuilder
▸ domel(tag: string,parent?: HTMLElement): DomElementBuilder<HTMLElement>
Parameters:
- tag:
string - parent:
HTMLElement, Optional
Returns DomElementBuilder<HTMLElement>
getDocSize
▸ getDocSize(): any
Returns any
getElementAbsolutePos
▸ getElementAbsolutePos(element: HTMLElement): any
Parameters:
- element:
HTMLElement
Returns any
getScrollPos
▸ getScrollPos(): any
Returns any
getViewportSize
▸ getViewportSize(): any
Returns any
getWinSize
▸ getWinSize(): any
Returns any
hideElement
Hides the html element.
▸ hideElement(element: HTMLElement): void
Parameters:
- element:
HTMLElement- The element to be hidden.
Returns void
isVisible
Checks if element is visible
▸ isVisible(element: HTMLElement): boolean
Parameters:
- element:
HTMLElement- The element to check.
Returns boolean - true if visible, otherwise - false.
renderPageNavigator
Creates the paging navigation element.
▸ renderPageNavigator(options: EqPagingOptions): HTMLElement
Parameters:
- options: EqPagingOptions - The [[EqPagingOptions]] object.
Returns HTMLElement - Created [[HTMLElement]].
showElement
Shows the html element.
▸ showElement(element: HTMLElement,display?: string): void
Parameters:
- element:
HTMLElement- The element to be shown. - display:
string, Optional - The value of "display" style to be set. Default value is "block".
Returns void
slideDown
▸ slideDown(target: HTMLElement,duration: number,callback?: () => void): void
Parameters:
- target:
HTMLElement - duration:
number - callback: () =>
void, Optional
Returns void
slideUp
▸ slideUp(target: HTMLElement,duration: number,callback?: () => void): void
Parameters:
- target:
HTMLElement - duration:
number - callback: () =>
void, Optional
Returns void
toggleVisibility
Hides the "first" element and shows the "second".
▸ toggleVisibility(first: HTMLElement,second: HTMLElement,options: any): void
Parameters:
- first:
HTMLElement- The element to be hidden. - second:
HTMLElement- The element to be shown. - options:
any- The options. The following options are applied: - display - the value of "display" style to be set. Default value is "block"
- duration - the duration of fading in and out
- complete - the callback to be called when toggle is complete
Returns void
wrapInner
Wraps all the elements inside "parent" by "wrapper" element
▸ wrapInner(parent: HTMLElement,wrapper: HTMLElement): void
Parameters:
- parent:
HTMLElement- The element to add wrapper to. - wrapper:
HTMLElement- The element that will wrap child elements.
Returns void