All functions are part of the EyeAbleAPI Object. All following functions have to be called with the EyeAbleAPI object as a reference.
//Example how to call a function of the Eye-ABle API
EyeAbleAPI.resetAll();
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.
//Example Run a custom function once Eye-Able has been initalized.
document.addEventListener("eyeable:init_completed", func);
Reset all active functions.
Opens/Closes the Eye-Able toolbar
Sets a new level for the adaptive Zoom.
(any)
{number} value between 0 and 20. Individual maximum zoom levels may be active depending on the website config.
Return the current font enlargement level
number
:
Font enlargement level
Increases level of the adaptive Zoom.
Increases level of the adaptive Zoom.
Toggles the currently selected contrast.
Enables the contrast feature.
(any)
{string} rgb code of the target background color, e.g. rgb(0, 0, 0)
(any)
{string} rgb code of the target text color, e.g. rgb(255, 255, 255)
Example usage of the contrast feature
EyeAbleAPI.enableContrast("rgb(0, 0, 0)","rgb(255, 255, 255)");
//Reset
EyeAbleAPI.disableContrast();
Resets any active color contrast
Return the current color mode
string
:
"Contrast" for Contrastmode, "Darkmode" for Darkmode and "0" for no active Colormode
Toggle the blue filter function.
Enables the blue filter.
(any)
{float} optional blue filter level [0,1]. If none given uses the current value.
Disable the bluefilter.
Returns the Bluefilter State
boolean
:
True if enabled, False if off
Toggle the Darkmode.
Toggles the screenreader functions.
Toggles the Screenreader and starts/stops the automatic output of the whole website.
Gets the screendreader state
boolean
:
True if enabled, false if off
Toggles the tab-navigation functions.
Gets the tab navigation state
boolean
:
True if enabled, false if off
Opens/Closes the contrast window.
Opens/Closes the color correction window.
Gets the state of the Color Correction function
boolean
:
True if enabled, false if off
Opens/Closes the functions window.
Toggle the hide images function.
Gets the state of the Hide Images function
boolean
:
True if enabled, false if off
Toggle the accesible font.
Gets the state of the Hide Images function
boolean
:
True if enabled, false if off
Toggles the big Cursor.
Enables the big Cursor.
Disables the big Cursor
Gets the state of the Hide Images function
boolean
:
True if enabled, false if off