Functions
# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)
getField(api_name) → {Field}
Get the Field by api name
Parameters:
Name | Type | Description |
---|---|---|
api_name |
String | Api Name of field |
Examples
const field = ZDK.Page.getField('Last_Name'); // field => { getApiName: ƒ }
field.getApiName();
Last_Name
# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)
getFields() → {Array.<Field>}
Get the list of fields in the Page as an array
Examples
let fields = ZDK.Page.getFields(); // fields=> { getApiName: ƒ }
fields[0].getApiName();
Annual_Revenue
# Create / Edit / Clone Pages
getSubform(api_name) → {Subform}
Get the Subform by api name
Parameters:
Name | Type | Description |
---|---|---|
api_name |
String | Api Name of subform |
Example
ZDK.Page.getSubform('CFSubform');
# List Page (Standard) Wizard
getComponent(name) → {Component}
Get the Pages' Component by name
Parameters:
Name | Type | Description |
---|---|---|
name |
String | Name of the component
|
Example
ZDK.Page.getComponent('list-custom-view');
# List Page (Standard) Wizard
getComponents() → {array}
Get the list of components in the Page as an array
Component object array
Example
ZDK.Page.getComponents();
# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)
getForm() → {Form}
Get the form object
Example
ZDK.Page.getForm();
#
getButtonByID(id) → {Button}
Get the Pages' Button by ID
Parameters:
Name | Type | Description |
---|---|---|
id |
String | id of the button |
Example
ZDK.Page.getButtonByID('118881188181');
#
getButton(api_name) → {Button}
Get the Pages' Button by api name
Parameters:
Name | Type | Description |
---|---|---|
api_name |
String | API Name of the button |
Examples
let button = ZDK.Page.getButton('record_save'); // button => {getId: ƒ, getApiName: ƒ, getType: ƒ}
button.getApiName();
record_save
#
getButtons() → {Array.<Button>}
Get the list of buttons in the Page as an array
Examples
let buttons = ZDK.Page.getButtons(); // btns=> {getId: ƒ, getApiName: ƒ, getType: ƒ}
buttons[0].getApiName();
page_back
# Detail Page (Canvas) Detail Page (Standard)
getLinkByID(id) → {Link}
Get the link in the page by id
Parameters:
Name | Type | Description |
---|---|---|
id |
String | ID of the link |
Example
ZDK.Page.getLinkByID('11011323443');
# Detail Page (Canvas) Detail Page (Standard)
getLinks() → {Array.<Link>}
Get the list of links in the Page as an array
Example
ZDK.Page.getLinks();
# Detail Page (Canvas) Detail Page (Standard)
getBlueprintTransitionByID() → {BlueprintTransition}
get blueprint transition by id
Example
ZDK.Page.getBlueprintTransitionByID('104567100090');
# Detail Page (Canvas) Detail Page (Standard)
getBlueprintTransitions() → {Array.<BlueprintTransition>}
get blueprint transitions in page
BlueprintTransition array
Example
ZDK.Page.getBlueprintTransitions();
# Detail Page (Canvas) Detail Page (Standard)
addTag(…tag_names)
Add tags in the page
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
tag_names |
String |
<repeatable> |
Name of the tag |
Examples
ZDK.Page.addTag('tagname');
ZDK.Page.addTag('tagname1', 'tagname2', 'tagname3');
# Detail Page (Canvas) Detail Page (Standard)
removeTag(…tag_names)
Remove tags in the page
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
tag_names |
String |
<repeatable> |
Name of the tag |
Examples
ZDK.Page.removeTag('tagname');
ZDK.Page.removeTag('tagname1', 'tagname2', 'tagname3');
# Detail Page (Canvas) Detail Page (Standard)
getTags() → {Array.<object>}
Get the list of tags in the Page as array of objects
object array
Examples
ZDK.Page.getTags();
[{ name: 'tag1' }, { name : 'atom' }, { name : 'busy' }]