☰
X
Concepts
Reference
Site Administration
Tutorials
Release Notes
v12.1.1
2
https://docs.skuid.com/v12.1.1/v2/en/
False
Version: v12.1.1
API Version: v2
<no title>
<no title>
Guides
Get Started with Skuid
Composing in Skuid: a Deep Dive
Skuid Platform: Quickstart
Creating a data source connection in Skuid Platform
Tour of Skuid Platform
Skuid Platform Subscriptions and Usage
<no title>
The App Composer
Using the Keyboard: Shortcuts, Hotkeys, and Accessibility
Debugging Skuid in the Console
Best Practices
Upgrading Skuid on Salesforce
Page Performance Guide
Skuid and Salesforce Lightning Performance Tips
One Save Button Per Page
Styling Best Practices
Tutorials
Skuid Page Tutorials
Add Related Lists with the Table Component
Build an Activities Related List Tab
Build a Custom “Create New Record” Page
Build a Custom Detail Page
Build a Custom List Page
Compose a Branded Header and Navigation
Compose a One-Page App Using Tab Actions and Conditional Rendering
Conditionally Display Fields
Create a Custom Clone Page
Create a Custom “Clone Account” page
Highlight Critical Data: Wrappers, Rich Text, and Ui-Only Fields
Mass Create Records
Show Products in an Opportunity Page
Skuid Pages for standard Salesforce CRM
Salesforce Tutorials
Add Product Line Items to Opportunities with a Popup
Add Gmail to Salesforce functionality in your email fields
Create a Custom Edit Page and Set Visualforce Overrides
Getting Help: Grant Skuid Login Rights to your Org
Reclaim the Salesforce Home Page
Redirect to Salesforce Processes
Skuid for Sales: A Turn-Key Template to Augment Lightning Sales Cloud
JavaScript Tutorials
Progress Indicator Component
Simple Map Component
Use a Snippet as a Filter Item Source to create “Dependent Filters”
Use Inline Javascript to Create a Slider Field Renderer
Legal terms and conditions
API Reference
skuid.runtime
skuid.$
skuid.actions
skuid.ajax
skuid.builder.core
skuid.builder.core.coreProps
skuid.calendar
skuid.collaboration
skuid.component
skuid.componentType
skuid.events
skuid.formula
skuid.hotkeys
skuid.label
skuid.load
skuid.model
skuid.model.Model
skuid.mustache
skuid.page
skuid.sfdc
skuid.snippet
skuid.time
skuid.utils
skuid.version
Component-Specific APIs
Skuid Model Metadata Object
Skuid Model Child Relationship Metadata Object
Skuid Model Condition Metadata Object
Skuid Model Field Metadata Object
Skuid Model Record Type Metadata Object
Show all sections
Collapse all sections
Search Term Highlighting: On
Version: v12.1.1
API Version: v2
In This Section
<no title>
<no title>
Guides
Get Started with Skuid
Composing in Skuid: a Deep Dive
Skuid Platform: Quickstart
Creating a data source connection in Skuid Platform
Tour of Skuid Platform
Skuid Platform Subscriptions and Usage
<no title>
The App Composer
Using the Keyboard: Shortcuts, Hotkeys, and Accessibility
Debugging Skuid in the Console
Best Practices
Upgrading Skuid on Salesforce
Page Performance Guide
Skuid and Salesforce Lightning Performance Tips
One Save Button Per Page
Styling Best Practices
Tutorials
Skuid Page Tutorials
Add Related Lists with the Table Component
Build an Activities Related List Tab
Build a Custom “Create New Record” Page
Build a Custom Detail Page
Build a Custom List Page
Compose a Branded Header and Navigation
Compose a One-Page App Using Tab Actions and Conditional Rendering
Conditionally Display Fields
Create a Custom Clone Page
Create a Custom “Clone Account” page
Highlight Critical Data: Wrappers, Rich Text, and Ui-Only Fields
Mass Create Records
Show Products in an Opportunity Page
Skuid Pages for standard Salesforce CRM
Salesforce Tutorials
Add Product Line Items to Opportunities with a Popup
Add Gmail to Salesforce functionality in your email fields
Create a Custom Edit Page and Set Visualforce Overrides
Getting Help: Grant Skuid Login Rights to your Org
Reclaim the Salesforce Home Page
Redirect to Salesforce Processes
Skuid for Sales: A Turn-Key Template to Augment Lightning Sales Cloud
JavaScript Tutorials
Progress Indicator Component
Simple Map Component
Use a Snippet as a Filter Item Source to create “Dependent Filters”
Use Inline Javascript to Create a Slider Field Renderer
Legal terms and conditions
API Reference
skuid.runtime
skuid.$
skuid.actions
skuid.ajax
skuid.builder.core
skuid.builder.core.coreProps
skuid.calendar
skuid.collaboration
skuid.component
skuid.componentType
skuid.events
skuid.formula
skuid.hotkeys
skuid.label
skuid.load
skuid.model
skuid.model.Model
skuid.mustache
skuid.page
skuid.sfdc
skuid.snippet
skuid.time
skuid.utils
skuid.version
Component-Specific APIs
Skuid Model Metadata Object
Skuid Model Child Relationship Metadata Object
Skuid Model Condition Metadata Object
Skuid Model Field Metadata Object
Skuid Model Record Type Metadata Object
In This Topic
Index
A
|
C
|
D
|
F
|
G
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
A
Adapter() (built-in function)
C
childRelationships (None attribute)
childSObject (None attribute)
D
deleteable (None attribute)
F
field (None attribute)
findTabToActivate() (built-in function)
G
getSelectedTabId() (built-in function)
I
isAvailable (None attribute)
isCustom (None attribute)
isCustomSetting (None attribute)
isDefaultRecordTypeMapping (None attribute)
isFeedEnabled (None attribute)
isQueryable (None attribute)
isSearchable (None attribute)
J
joinField (None attribute)
joinObject (None attribute)
K
keyPrefix (None attribute)
L
label (None attribute)
labelPlural (None attribute)
M
mergeField (None attribute)
model (None attribute)
modelFieldMetadata. createable (modelFieldMetadata attribute)
modelFieldMetadata.accessible (modelFieldMetadata attribute)
modelFieldMetadata.autoNumber (modelFieldMetadata attribute)
modelFieldMetadata.calculated (modelFieldMetadata attribute)
modelFieldMetadata.controllingField (modelFieldMetadata attribute)
modelFieldMetadata.defaultValue (modelFieldMetadata attribute)
modelFieldMetadata.digits (modelFieldMetadata attribute)
modelFieldMetadata.displaytype (modelFieldMetadata attribute)
modelFieldMetadata.editable (modelFieldMetadata attribute)
modelFieldMetadata.filterable (modelFieldMetadata attribute)
modelFieldMetadata.function (modelFieldMetadata attribute)
modelFieldMetadata.groupable (modelFieldMetadata attribute)
modelFieldMetadata.htmlFormatted (modelFieldMetadata attribute)
modelFieldMetadata.id (modelFieldMetadata attribute)
modelFieldMetadata.inlineHelpText (modelFieldMetadata attribute)
modelFieldMetadata.length (modelFieldMetadata attribute)
modelFieldMetadata.nameField (modelFieldMetadata attribute)
modelFieldMetadata.namePointing (modelFieldMetadata attribute)
modelFieldMetadata.orderByClause (modelFieldMetadata attribute)
modelFieldMetadata.picklistEntries (modelFieldMetadata attribute)
modelFieldMetadata.precision (modelFieldMetadata attribute)
modelFieldMetadata.query (modelFieldMetadata attribute)
modelFieldMetadata.recordsLimit (modelFieldMetadata attribute)
modelFieldMetadata.ref (modelFieldMetadata attribute)
modelFieldMetadata.referenceTo (modelFieldMetadata attribute)
modelFieldMetadata.refprefix (modelFieldMetadata attribute)
modelFieldMetadata.rel (modelFieldMetadata attribute)
modelFieldMetadata.required (modelFieldMetadata attribute)
modelFieldMetadata.scale (modelFieldMetadata attribute)
modelFieldMetadata.sortable (modelFieldMetadata attribute)
modelFieldMetadata.subFields (modelFieldMetadata attribute)
N
name (None attribute)
new skuid.builder.core.Builder() (class)
new skuid.builder.core.Builder.skuid.builder.core.Builder.componentRenderer (new skuid.builder.core.Builder.skuid.builder.core.Builder attribute)
new skuid.builder.core.Builder.skuid.builder.core.Builder.defaultStateGenerator: (new skuid.builder.core.Builder.skuid.builder.core.Builder attribute)
new skuid.builder.core.Builder.skuid.builder.core.Builder.description (new skuid.builder.core.Builder.skuid.builder.core.Builder attribute)
new skuid.builder.core.Builder.skuid.builder.core.Builder.hideFromComponentsList (new skuid.builder.core.Builder.skuid.builder.core.Builder attribute)
new skuid.builder.core.Builder.skuid.builder.core.Builder.icon (new skuid.builder.core.Builder.skuid.builder.core.Builder attribute)
new skuid.builder.core.Builder.skuid.builder.core.Builder.id (new skuid.builder.core.Builder.skuid.builder.core.Builder attribute)
new skuid.builder.core.Builder.skuid.builder.core.Builder.name (new skuid.builder.core.Builder.skuid.builder.core.Builder attribute)
new skuid.builder.core.Builder.skuid.builder.core.Builder.propertiesRenderer() (new skuid.builder.core.Builder.skuid.builder.core.Builder method)
new skuid.builder.core.Builder.skuid.builder.core.Builder.skuid.builder.core.Builder.propertiesRenderer.propertiesObject.setTitle() (new skuid.builder.core.Builder.skuid.builder.core.Builder.skuid.builder.core.Builder.propertiesRenderer.propertiesObject method)
noValueBehavior (None attribute)
O
objectName (None attribute)
onChange() (built-in function)
operator (None attribute)
originalInactive (None attribute)
P
parameters.customNodeId (parameters attribute)
parameters.icon (parameters attribute)
parameters.linkedComponent (parameters attribute)
parameters.props (parameters attribute)
parameters.useModelName (parameters attribute)
R
recordTypeId (None attribute)
recordTypeInfos (None attribute)
relationshipName (None attribute)
S
search.Request (search attribute)
search.Result (search attribute)
search.Resultsearch.SObjectResult (search.Resultsearch attribute)
search.SObjectRequest (search attribute)
selectTab() (built-in function)
skuid.actions.runActionsNode() (skuid.actions method)
skuid.adapter.get() (skuid.adapter method)
skuid.adapter.getAdapter() (skuid.adapter method)
skuid.adapter.getAll() (skuid.adapter method)
skuid.adapter.map() (skuid.adapter method)
skuid.ajax.proxy() (skuid.ajax method)
skuid.builder.core.componentFactory() (skuid.builder.core method)
skuid.builder.core.coreProps.component (skuid.builder.core.coreProps attribute)
skuid.builder.core.coreProps.cssClassProp() (skuid.builder.core.coreProps method)
skuid.builder.core.coreProps.uniqueIdProp() (skuid.builder.core.coreProps method)
skuid.builder.core.createModel() (skuid.builder.core method)
skuid.builder.core.getActionsCategory() (skuid.builder.core method)
skuid.builder.core.getBuilder() (skuid.builder.core method)
skuid.builder.core.getComponentFromState() (skuid.builder.core method)
skuid.builder.core.getFirstModel() (skuid.builder.core method)
skuid.builder.core.getHotkeysCategory() (skuid.builder.core method)
skuid.builder.core.getLastSelectedModelComponent() (skuid.builder.core method)
skuid.builder.core.getMetadataForField() (skuid.builder.core method)
skuid.builder.core.getModelFromModelName() (skuid.builder.core method)
skuid.builder.core.getRenderingCategory() (skuid.builder.core method)
skuid.builder.core.getStateProperty() (skuid.builder.core method)
skuid.builder.core.handleModelIdChange() (skuid.builder.core method)
skuid.builder.core.handleModelRemove() (skuid.builder.core method)
skuid.builder.core.options.select (skuid.builder.core.options attribute)
skuid.builder.core.parameters.label (skuid.builder.core.parameters attribute)
skuid.builder.core.registerBuilder() (skuid.builder.core method)
skuid.builder.core.registerComponent() (skuid.builder.core method)
skuid.builder.core.save() (skuid.builder.core method)
skuid.builder.core.updateStateProperty() (skuid.builder.core method)
skuid.calendar.Calendar (skuid.calendar attribute)
skuid.calendar.EventSource (skuid.calendar attribute)
skuid.collaboration.destroyAll() (skuid.collaboration method)
skuid.component.Component (skuid.component attribute)
skuid.component.Component.createChildComponents() (skuid.component.Component method)
skuid.component.Component.isRendered (skuid.component.Component attribute)
skuid.component.Component.prototype.addProblem() (skuid.component.Component.prototype method)
skuid.component.Component.prototype.addProblems() (skuid.component.Component.prototype method)
skuid.component.Component.prototype.conditionallyRender() (skuid.component.Component.prototype method)
skuid.component.Component.prototype.getElement() (skuid.component.Component.prototype method)
skuid.component.Component.prototype.getId() (skuid.component.Component.prototype method)
skuid.component.Component.prototype.getType() (skuid.component.Component.prototype method)
skuid.component.Component.prototype.id() (skuid.component.Component.prototype method)
skuid.component.Component.prototype.render() (skuid.component.Component.prototype method)
skuid.component.Component.prototype.unregister() (skuid.component.Component.prototype method)
skuid.component.Component.prototype.unrender() (skuid.component.Component.prototype method)
skuid.component.Component.xmlDefinition (skuid.component.Component attribute)
skuid.component.factory() (skuid.component method)
skuid.component.getAll() (skuid.component method)
skuid.component.getById() (skuid.component method)
skuid.component.getByType() (skuid.component method)
skuid.component.register() (skuid.component method)
skuid.componentType.get() (skuid.componentType method)
skuid.componentType.getAll() (skuid.componentType method)
skuid.componentType.list() (skuid.componentType method)
skuid.componentType.map() (skuid.componentType method)
skuid.componentType.register() (skuid.componentType method)
skuid.componentType.unregister() (skuid.componentType method)
skuid.events.models.cancelled (skuid.events.models attribute)
skuid.events.models.loaded (skuid.events.models attribute)
skuid.events.models.saved (skuid.events.models attribute)
skuid.events.models.saveHandled (skuid.events.models attribute)
skuid.events.models.saveInitiated (skuid.events.models attribute)
skuid.events.publish() (skuid.events method)
skuid.events.row.created (skuid.events.row attribute)
skuid.events.row.deleted (skuid.events.row attribute)
skuid.events.row.undeleted (skuid.events.row attribute)
skuid.events.row.updated (skuid.events.row attribute)
skuid.events.subscribe() (skuid.events method)
skuid.events.subscribeOnce() (skuid.events method)
skuid.events.unsubscribe() (skuid.events method)
skuid.formula.Formula() (class)
skuid.hotkeys.bind() (skuid.hotkeys method)
skuid.hotkeys.unbind() (skuid.hotkeys method)
skuid.label.add() (skuid.label method)
skuid.label.getAll() (skuid.label method)
skuid.label.map() (skuid.label method)
skuid.label.merge() (skuid.label method)
skuid.label.parse() (skuid.label method)
skuid.label.read() (skuid.label method)
skuid.load.css() (skuid.load method)
skuid.load.js() (skuid.load method)
skuid.model.cancel() (skuid.model method)
skuid.model.Condition() (skuid.model method)
skuid.model.Condition.field (skuid.model.Condition attribute)
skuid.model.Condition.values (skuid.model.Condition attribute)
skuid.model.Field() (skuid.model method)
skuid.model.getModel() (skuid.model method)
skuid.model.getModelsByService() (skuid.model method)
skuid.model.getModelsList() (skuid.model method)
skuid.model.getMoreData() (skuid.model method)
skuid.model.isNewId() (skuid.model method)
skuid.model.list() (skuid.model method)
skuid.model.load() (skuid.model method)
skuid.model.map() (skuid.model method)
skuid.model.Model() (skuid.model method)
skuid.model.Model.abandonAllRows() (skuid.model.Model method)
skuid.model.Model.abandonRow() (skuid.model.Model method)
skuid.model.Model.abandonRows() (skuid.model.Model method)
skuid.model.Model.activateCondition() (skuid.model.Model method)
skuid.model.Model.adoptRows() (skuid.model.Model method)
skuid.model.Model.cancel() (skuid.model.Model method)
skuid.model.Model.canRetrieveMoreRows (skuid.model.Model attribute)
skuid.model.Model.changes (skuid.model.Model attribute)
skuid.model.Model.conditionLogic (skuid.model.Model attribute)
skuid.model.Model.conditions (skuid.model.Model attribute)
skuid.model.Model.createRow() (skuid.model.Model method)
skuid.model.Model.createRowIfNoneFound (skuid.model.Model attribute)
skuid.model.Model.data (skuid.model.Model attribute)
skuid.model.Model.dataMap (skuid.model.Model attribute)
skuid.model.Model.deactivateCondition() (skuid.model.Model method)
skuid.model.Model.deleteRow() (skuid.model.Model method)
skuid.model.Model.emptyData() (skuid.model.Model method)
skuid.model.Model.evaluateFormulaField() (skuid.model.Model method)
skuid.model.Model.evaluateFormulaFields() (skuid.model.Model method)
skuid.model.Model.exportData() (skuid.model.Model method)
skuid.model.Model.fields (skuid.model.Model attribute)
skuid.model.Model.fieldsMap (skuid.model.Model attribute)
skuid.model.Model.getConditionByName() (skuid.model.Model method)
skuid.model.Model.getField() (skuid.model.Model method)
skuid.model.Model.getFieldValue() (skuid.model.Model method)
skuid.model.Model.getFirstRow() (skuid.model.Model method)
skuid.model.Model.getRowById() (skuid.model.Model method)
skuid.model.Model.getRows() (skuid.model.Model method)
skuid.model.Model.groupByFields (skuid.model.Model attribute)
skuid.model.Model.groupByMethod (skuid.model.Model attribute)
skuid.model.Model.hasChanged (skuid.model.Model attribute)
skuid.model.Model.id (skuid.model.Model attribute)
skuid.model.Model.isRowChanged() (skuid.model.Model method)
skuid.model.Model.isRowMarkedForDeletion() (skuid.model.Model method)
skuid.model.Model.isRowNew() (skuid.model.Model method)
skuid.model.Model.isRowUnsavedClone() (skuid.model.Model method)
skuid.model.Model.loadAllRemainingRecords() (skuid.model.Model method)
skuid.model.Model.loadNextOffsetPage() (skuid.model.Model method)
skuid.model.Model.orderByClause (skuid.model.Model attribute)
skuid.model.Model.originals (skuid.model.Model attribute)
skuid.model.Model.readonly (skuid.model.Model attribute)
skuid.model.Model.recordsLimit (skuid.model.Model attribute)
skuid.model.Model.registeredFields (skuid.model.Model attribute)
skuid.model.Model.removeRowById() (skuid.model.Model method)
skuid.model.Model.resetCondition() (skuid.model.Model method)
skuid.model.Model.save() (skuid.model.Model method)
skuid.model.Model.setCondition() (skuid.model.Model method)
skuid.model.Model.soql (skuid.model.Model attribute)
skuid.model.Model.type (skuid.model.Model attribute)
skuid.model.Model.undeleteRow() (skuid.model.Model method)
skuid.model.Model.updateData() (skuid.model.Model method)
skuid.model.Model.updateRow() (skuid.model.Model method)
skuid.model.Model.updateRows() (skuid.model.Model method)
skuid.model.Model.validateRequiredFields() (skuid.model.Model method)
skuid.model.save() (skuid.model method)
skuid.model.skuid.model.Condition.inactive (skuid.model.skuid.model.Condition attribute)
skuid.model.skuid.model.Condition.skuid.model.Condition.value (skuid.model.skuid.model.Condition.skuid.model.Condition attribute)
skuid.model.updateData() (skuid.model method)
skuid.page.currentSiteUrl (skuid.page attribute)
skuid.page.editable (skuid.page attribute)
skuid.page.getAllProblems() (skuid.page method)
skuid.page.getParameters() (skuid.page method)
skuid.page.id (skuid.page attribute)
skuid.page.name (skuid.page attribute)
skuid.page.runningOnForceSite() (skuid.page method)
skuid.page.sfdcDomain() (skuid.page method)
skuid.page.sitePrefix (skuid.page attribute)
skuid.runtime.getPage() (skuid.runtime method)
skuid.runtime.getPageList() (skuid.runtime method)
skuid.runtime.getPageMap() (skuid.runtime method)
skuid.service.api() (skuid.service method)
skuid.service.getService() (skuid.service method)
skuid.service.map() (skuid.service method)
skuid.service.search() (skuid.service method)
skuid.service.Service (skuid.service attribute)
skuid.snippet.get (skuid.snippet attribute)
skuid.snippet.getSnippet() (skuid.snippet method)
skuid.snippet.register (skuid.snippet attribute)
skuid.snippet.registerSnippet() (skuid.snippet method)
skuid.snippet.unregister (skuid.snippet attribute)
skuid.time.amPm (skuid.time attribute)
skuid.time.dayNames (skuid.time attribute)
skuid.time.dayNamesMin (skuid.time attribute)
skuid.time.dayNamesShort (skuid.time attribute)
skuid.time.formatDate() (skuid.time method)
skuid.time.formatTime() (skuid.time method)
skuid.time.getLocalDateTime() (skuid.time method)
skuid.time.getRealJSDateTimeFromLocal() (skuid.time method)
skuid.time.getSFDate() (skuid.time method)
skuid.time.getSFDateTime() (skuid.time method)
skuid.time.makeFormattedDate() (skuid.time method)
skuid.time.makeFormattedDateFromJS() (skuid.time method)
skuid.time.monthNames (skuid.time attribute)
skuid.time.monthNamesShort (skuid.time attribute)
skuid.time.parseSFDate() (skuid.time method)
skuid.time.parseSFDateTime() (skuid.time method)
skuid.time.setUserTimeZone() (skuid.time method)
skuid.utils.convertCurrency() (skuid.utils method)
skuid.utils.createModal() (skuid.utils method)
skuid.utils.decodeHTML() (skuid.utils method)
skuid.utils.delayInputCallback() (skuid.utils method)
skuid.utils.encodeHTML() (skuid.utils method)
skuid.utils.escapeSingleQuotes() (skuid.utils method)
skuid.utils.generateGUID() (skuid.utils method)
skuid.utils.getObjectProperty() (skuid.utils method)
skuid.utils.getUrlFromAttachmentId() (skuid.utils method)
skuid.utils.getXML() (skuid.utils method)
skuid.utils.hasObjectProperty() (skuid.utils method)
skuid.utils.isMultiCurrencyOrganization (skuid.utils attribute)
skuid.utils.makeXMLDoc() (skuid.utils method)
skuid.utils.merge() (skuid.utils method)
skuid.utils.mergeAsText() (skuid.utils method)
skuid.utils.mergeAsTextInContext() (skuid.utils method)
skuid.utils.setObjectProperty() (skuid.utils method)
skuid.utils.size() (skuid.utils method)
skuid.utils.userInfo (skuid.utils attribute)
skuid.utils.userLocale (skuid.utils attribute)
skuid.version.date (skuid.version attribute)
skuid.version.major (skuid.version attribute)
skuid.version.minor (skuid.version attribute)
skuid.version.name (skuid.version attribute)
skuid.version.number (skuid.version attribute)
subConditionLogic (None attribute)
subConditions (None attribute)
T
type (None attribute)
U
updateable (None attribute)