Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Div
classcomponent-api-page

Anchor
top
top

The Temporary Settings Store subcomponent is used by UI Enhancer to store/save user preferences temporarily, without persistence. This store may be useful for testing situations. For a settings store that persists, use the Cookie Settings Store.

Do not use this component directly. The information on this page should be use when customizing UI Enhancer.

See Also
UI Enhancer
Cookie Settings Store

Div
classsummary-table

Supported Events

none

#MethodsMethods

#fetchget()
Retrieves the current settings from the cookie.


#saveset(settings)
Saves the specified settings in the cookie.

Methods

Span
classback-to-top
back to top

fetch

get()

Div
classapi-table
none javascript

Description

Retrieves the current settings stored in the cookie.

ParametersNone

Return value

A JavaScript object containing the The currently stored settings. This object has the following format:

Code Block
javascript
{
    textFont: <string>, // key from classname map
    theme: <string>, // key from classname map
    textSize: <number>, // in points
    lineSpacing: <number>, // in ems
    layout: <boolean>,
    toc: <boolean>,
    links: <boolean>,
    inputsLarger: <boolean>
}

Availability

Infusion 1.4 and later

See also

#saveset(settings)

save

set(settings)

 

Div
classapi-table
{ textFont: <string>, // key from classname map theme: <string>, // key from classname map textSize: <number>, // in points lineSpacing: <number>, // in ems layout: <boolean>, toc: <boolean>, links: <boolean>, inputsLarger: <boolean> }

It could be any data type.

Description

Stores the specified settings in the cookie.

Parameters

settings
A JavaScript object containing the settings to be stored.
Form:

Code Block
javascriptjavascript

Return value

None

Availability

Infusion 1.4 and later

See also

#fetchget()