new nlobjPortlet() → {nlobjPortlet}
Return a new instance of nlobjPortlet used for scriptable dashboard portlet.
- Source:
- nlapihandler_stubs.js, line 3361
Returns:
- Type
- nlobjPortlet
Methods
-
addColumn(name, type, label, align)
-
add a column (nlobjColumn) to this LIST portlet and return it.
Parameters:
Name Type Argument Description name
string column name type
string column type label
string column label align
string <optional>
column alignment - Since:
- 2008.2
- Source:
- nlapihandler_stubs.js, line 3388
-
addEditColumn(column, showView, showHref) → {nlobjColumn}
-
add an Edit column (nlobjColumn) to the left of the column specified (supported on LIST portlets only).
Parameters:
Name Type Argument Description column
nlobjColumn showView
boolean should Edit|View instead of Edit link showHref
string <optional>
column that evaluates to T or F that determines whether to disable the edit|view link per-row. - Since:
- 2008.2
- Source:
- nlapihandler_stubs.js, line 3400
Returns:
- Type
- nlobjColumn
-
addField(name, type, label, source) → {nlobjField}
-
add a field (nlobjField) to this FORM portlet and return it.
Parameters:
Name Type Argument Description name
string field name type
string field type label
string <optional>
field label source
string, int <optional>
script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields - Since:
- 2008.2
- Source:
- nlapihandler_stubs.js, line 3429
Returns:
- Type
- nlobjField
-
addLine(text, url, indent)
-
add a line (containing text or simple HTML) with optional indenting and URL to this LINKS portlet.
Parameters:
Name Type Argument Description text
string data to output to line url
string <optional>
URL if this line should be clickable (if NULL then line will not be clickable) indent
int # of indents to insert before text - Since:
- 2008.2
- Source:
- nlapihandler_stubs.js, line 3448
-
addRow(row)
-
add a row (nlobjSearchResult or Array of name-value pairs) to this LIST portlet.
Parameters:
Name Type Description row
string[] | nlobjSearchResult - Since:
- 2008.2
- Source:
- nlapihandler_stubs.js, line 3408
-
addRows(rows)
-
add multiple rows (Array of nlobjSearchResults or name-value pair Arrays) to this LIST portlet.
Parameters:
Name Type Description rows
string[][] | nlobjSearchResult[] - Since:
- 2008.2
- Source:
- nlapihandler_stubs.js, line 3416
-
setHtml(html)
-
set the entire contents of the HTML portlet (will be placed inside a
... ).Parameters:
Name Type Description html
string - Since:
- 2008.2
- Source:
- nlapihandler_stubs.js, line 3377
-
setSubmitButton(url, label)
-
add a FORM submit button to this FORM portlet.
Parameters:
Name Type Argument Description url
string URL that this form portlet will POST to label
string <optional>
label for submit button (defaults to Save) - Since:
- 2008.2
- Source:
- nlapihandler_stubs.js, line 3438
-
setTitle(title)
-
set the portlet title.
Parameters:
Name Type Description title
string - Since:
- 2008.2
- Source:
- nlapihandler_stubs.js, line 3369