From 683bc54fd9bfc22c900dc0cdfcd660d61da253ef Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Thu, 6 Aug 2020 17:58:47 +0200 Subject: docs: update js api docs Signed-off-by: Jo-Philipp Wich --- docs/jsapi/LuCI.form.AbstractSection.html | 886 +++++++++++++++++++++++++++++- 1 file changed, 877 insertions(+), 9 deletions(-) (limited to 'docs/jsapi/LuCI.form.AbstractSection.html') diff --git a/docs/jsapi/LuCI.form.AbstractSection.html b/docs/jsapi/LuCI.form.AbstractSection.html index 455e36b2f3..0d4d49f509 100644 --- a/docs/jsapi/LuCI.form.AbstractSection.html +++ b/docs/jsapi/LuCI.form.AbstractSection.html @@ -292,8 +292,16 @@
  • cfgsections
    • +
  • cfgvalue
    • +
  • filter
    • +
  • formvalue
    • + +
  • getOption
    • + +
  • getUIElement
    • +
  • load
  • option
    • @@ -333,6 +341,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • readonly
    • @@ -423,6 +433,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -513,6 +525,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -599,6 +613,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -693,6 +709,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -783,6 +801,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -873,6 +893,8 @@
  • modaltitle
    • +
  • nodescriptions
    • +
  • parentoption
  • rowcolors
    • @@ -900,8 +922,16 @@
  • append
    • +
  • cfgvalue
    • +
  • filter
    • +
  • formvalue
    • + +
  • getOption
    • + +
  • getUIElement
    • +
  • load
  • option
    • @@ -939,6 +969,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -1071,8 +1103,12 @@ Members +
  • orientation
    • +
  • size
    • +
  • widget
    • +
  • datatype
  • default
    • @@ -1081,6 +1117,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -1225,6 +1263,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -1324,8 +1364,16 @@
  • cfgsections
    • +
  • cfgvalue
    • +
  • filter
    • +
  • formvalue
    • + +
  • getOption
    • + +
  • getUIElement
    • +
  • load
  • option
    • @@ -1367,6 +1415,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -1457,6 +1507,8 @@
  • modaltitle
    • +
  • nodescriptions
    • +
  • rowcolors
  • sectiontitle
    • @@ -1492,8 +1544,16 @@
  • append
    • +
  • cfgvalue
    • +
  • filter
    • +
  • formvalue
    • + +
  • getOption
    • + +
  • getUIElement
    • +
  • load
  • option
    • @@ -1539,6 +1599,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • password
    • @@ -1642,8 +1704,16 @@
  • cfgsections
    • +
  • cfgvalue
    • +
  • filter
    • +
  • formvalue
    • + +
  • getOption
    • + +
  • getUIElement
    • +
  • load
  • option
    • @@ -1687,6 +1757,8 @@
  • modalonly
    • +
  • onchange
    • +
  • optional
  • readonly
    • @@ -2520,6 +2592,8 @@
  • getLocalData
    • +
  • getToken
    • +
  • setLocalData
    • @@ -2670,6 +2744,8 @@
  • getValue
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
    • @@ -2678,6 +2754,8 @@
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • setValue
    • @@ -2748,6 +2826,8 @@
  • getValue
    • +
  • isChanged
    • +
  • isChecked
  • isValid
    • @@ -2758,6 +2838,8 @@
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • setValue
    • @@ -2798,12 +2880,16 @@
  • closeAllDropdowns
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • triggerValidation
    • @@ -2842,12 +2928,16 @@
  • closeAllDropdowns
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • triggerValidation
    • @@ -2888,6 +2978,8 @@
  • getValue
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
    • @@ -2896,6 +2988,8 @@
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • setValue
    • @@ -2936,6 +3030,8 @@
  • getValue
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
    • @@ -2944,6 +3040,8 @@
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • setValue
    • @@ -2980,6 +3078,8 @@
  • getValue
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
    • @@ -2988,6 +3088,8 @@
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • setValue
    • @@ -3020,6 +3122,8 @@
  • getValue
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
    • @@ -3028,6 +3132,8 @@
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • setValue
    • @@ -3098,6 +3204,8 @@
  • getValue
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
    • @@ -3106,6 +3214,8 @@
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • setValue
    • @@ -3170,6 +3280,8 @@
  • getValue
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
    • @@ -3178,6 +3290,8 @@
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • setValue
    • @@ -3214,6 +3328,8 @@
  • getValue
    • +
  • isChanged
    • +
  • isValid
  • registerEvents
    • @@ -3222,6 +3338,8 @@
  • setChangeEvents
    • +
  • setPlaceholder
    • +
  • setUpdateEvents
  • setValue
    • @@ -3346,7 +3464,7 @@ form options and for handling tabs to segment child options.

    - form.js, line 805 + form.js, line 808
    @@ -3607,7 +3725,7 @@ this property will hold a reference to the parent option instance.

    - form.js, line 856 + form.js, line 859
    @@ -3722,6 +3840,202 @@ The sections will be rendered in the same order as the returned array. + + + + +
    +
    +

    + + cfgvalue(section_id, option){null|string|Array.<string>|Object.<string, (null|string|Array.<string>)>} +

    + + +
    + form.js, line 1078 +
    + +
    + + +
    +
    + + +
    +

    Query underlying option configuration values.

    +

    This function is sensitive to the amount of arguments passed to it; +if only one argument is specified, the configuration values of all +options within this section are returned as dictionary.

    +

    If both the section ID and an option name are supplied, this function +returns the configuration value of the specified option only.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    section_id + + +string + + + + + + + + + + +

    The configuration section ID

    option + + +string + + + + + + + optional + + + + + +

    The name of the option to query

    + + + +
    + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Returns:
    + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + + null + | + + string + | + + Array.<string> + | + + Object.<string, (null|string|Array.<string>)> + + + Returns either a dictionary of option names and their corresponding +configuration values or just a single configuration value, depending +on the amount of passed arguments.
    + + + +
    @@ -3735,7 +4049,7 @@ The sections will be rendered in the same order as the returned array.
    - form.js, line 879 + form.js, line 882
    @@ -3874,6 +4188,560 @@ custom implementations.

    + + + + +
    +
    +

    + + formvalue(section_id, option){null|string|Array.<string>|Object.<string, (null|string|Array.<string>)>} +

    + + +
    + form.js, line 1111 +
    + +
    + + +
    +
    + + +
    +

    Query underlying option widget input values.

    +

    This function is sensitive to the amount of arguments passed to it; +if only one argument is specified, the widget input values of all +options within this section are returned as dictionary.

    +

    If both the section ID and an option name are supplied, this function +returns the widget input value of the specified option only.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    section_id + + +string + + + + + + + + + + +

    The configuration section ID

    option + + +string + + + + + + + optional + + + + + +

    The name of the option to query

    + + + +
    + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Returns:
    + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + + null + | + + string + | + + Array.<string> + | + + Object.<string, (null|string|Array.<string>)> + + + Returns either a dictionary of option names and their corresponding +widget input values or just a single widget input value, depending +on the amount of passed arguments.
    + + + + +
    + + + +
    +
    +

    + + getOption(option){null|LuCI.form.AbstractValue|Object.<string, LuCI.form.AbstractValue>} +

    + + +
    + form.js, line 1177 +
    + +
    + + +
    +
    + + +
    +

    Obtain underlying option objects.

    +

    This function is sensitive to the amount of arguments passed to it; +if no option name is specified, all options within this section are +returned as dictionary.

    +

    If an option name is supplied, this function returns the matching +LuCI.form.AbstractValue instance only.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    option + + +string + + + + + + + optional + + + + + +

    The name of the option object to obtain

    + + + +
    + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Returns:
    + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + + null + | + + LuCI.form.AbstractValue + | + + Object.<string, LuCI.form.AbstractValue> + + + Returns either a dictionary of option names and their corresponding +option instance objects or just a single object instance value, +depending on the amount of passed arguments.
    + + + + +
    + + + +
    +
    +

    + + getUIElement(section_id, option){null|LuCI.ui.AbstractElement|Object.<string, (null|LuCI.ui.AbstractElement)>} +

    + + +
    + form.js, line 1147 +
    + +
    + + +
    +
    + + +
    +

    Obtain underlying option LuCI.ui widget instances.

    +

    This function is sensitive to the amount of arguments passed to it; +if only one argument is specified, the LuCI.ui widget instances of all +options within this section are returned as dictionary.

    +

    If both the section ID and an option name are supplied, this function +returns the LuCI.ui widget instance value of the specified option only.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    section_id + + +string + + + + + + + + + + +

    The configuration section ID

    option + + +string + + + + + + + optional + + + + + +

    The name of the option to query

    + + + +
    + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Returns:
    + + + + + + + + + + + + + + + + + + + + +
    TypeDescription
    + + null + | + + LuCI.ui.AbstractElement + | + + Object.<string, (null|LuCI.ui.AbstractElement)> + + + Returns either a dictionary of option names and their corresponding +widget input values or just a single widget input value, depending +on the amount of passed arguments.
    + + + +
    @@ -3887,7 +4755,7 @@ custom implementations.

    - form.js, line 894 + form.js, line 897
    @@ -3991,7 +4859,7 @@ elements load functions rejected with an error.
    - form.js, line 1007 + form.js, line 1010
    @@ -4206,7 +5074,7 @@ descendent of AbstractValue.

    - form.js, line 923 + form.js, line 926
    @@ -4567,7 +5435,7 @@ the form element's markup, including the markup of any child elements.
    - form.js, line 964 + form.js, line 967
    @@ -4784,7 +5652,7 @@ contents. If omitted, no description will be rendered.

    - form.js, line 1044 + form.js, line 1047
    @@ -5254,7 +6122,7 @@ was neither a string nor a function. -- cgit