| Documentation

EyeAbleAPI

All functions are part of the EyeAbleAPI Object. All following functions have to be called with the EyeAbleAPI object as a reference.

EyeAbleAPI

Example

//Example how to call a function of the Eye-ABle API
EyeAbleAPI.resetAll();

initEvent

Once the Eye-Able Plugin has been sucessfully initalized the "eyeable:init_completed" Event is thrown. Any changes at page load should be done using this event.

initEvent

Example

//Example Run a custom function once Eye-Able has been initalized.
document.addEventListener("eyeable:init_completed", func);

resetAll

Reset all active functions.

resetAll()

toggleToolbar

Opens/Closes the Eye-Able toolbar

toggleToolbar()

setZoomLevel

Sets a new level for the adaptive Zoom.

setZoomLevel(level: any)

Parameters

level (any) {number} value between 0 and 20. Individual maximum zoom levels may be active depending on the website config.

getZoomLevel

Return the current font enlargement level

getZoomLevel(): number

Returns

number: Font enlargement level

increaseZoomLevel

Increases level of the adaptive Zoom.

increaseZoomLevel()

decreaseZoomLevel

Increases level of the adaptive Zoom.

decreaseZoomLevel()

toggleContrast

Toggles the currently selected contrast.

toggleContrast()

enableContrast

Enables the contrast feature.

enableContrast(background: any, textcolor: any)

Parameters

background (any) {string} rgb code of the target background color, e.g. rgb(0, 0, 0)

textcolor (any) {string} rgb code of the target text color, e.g. rgb(255, 255, 255)

Example

Example usage of the contrast feature

EyeAbleAPI.enableContrast("rgb(0, 0, 0)","rgb(255, 255, 255)");
//Reset
EyeAbleAPI.disableContrast();

disableContrast

Resets any active color contrast

disableContrast()

getColorMode

Return the current color mode

getColorMode(): string

Returns

string: "Contrast" for Contrastmode, "Darkmode" for Darkmode and "0" for no active Colormode

toggleBluefilter

Toggle the blue filter function.

toggleBluefilter()

enableBluefilter

Enables the blue filter.

enableBluefilter(level: any)

Parameters

level (any) {float} optional blue filter level [0,1]. If none given uses the current value.

disableBluefilter

Disable the bluefilter.

disableBluefilter()

getBluefilterState

Returns the Bluefilter State

getBluefilterState(): boolean

Returns

boolean: True if enabled, False if off

toggleDarkmode

Toggle the Darkmode.

toggleDarkmode()

toggleScreenreader

Toggles the screenreader functions.

toggleScreenreader()

toggleReadWholePage

Toggles the Screenreader and starts/stops the automatic output of the whole website.

toggleReadWholePage()

getScreenreaderState

Gets the screendreader state

getScreenreaderState(): boolean

Returns

boolean: True if enabled, false if off

toggleTabNav

Toggles the tab-navigation functions.

toggleTabNav()

getTabNavState

Gets the tab navigation state

getTabNavState(): boolean

Returns

boolean: True if enabled, false if off

toggleContrastWindow

Opens/Closes the contrast window.

toggleContrastWindow()

toggleColorCorrectionWindow

Opens/Closes the color correction window.

toggleColorCorrectionWindow()

getColorCorrectionState

Gets the state of the Color Correction function

getColorCorrectionState(): boolean

Returns

boolean: True if enabled, false if off

toggleMoreFunctionsWindow

Opens/Closes the functions window.

toggleMoreFunctionsWindow()

toggleHideImages

Toggle the hide images function.

toggleHideImages()

getHideImagesState

Gets the state of the Hide Images function

getHideImagesState(): boolean

Returns

boolean: True if enabled, false if off

toggleAccessibleFont

Toggle the accesible font.

toggleAccessibleFont()

getAccessibleFontState

Gets the state of the Hide Images function

getAccessibleFontState(): boolean

Returns

boolean: True if enabled, false if off

toggleBigCursor

Toggles the big Cursor.

toggleBigCursor()

enableBigCursor

Enables the big Cursor.

enableBigCursor()

disableBigCursor

Disables the big Cursor

disableBigCursor()

getBigCursorState

Gets the state of the Hide Images function

getBigCursorState(): boolean

Returns

boolean: True if enabled, false if off