FileMaker Data API Tools API - v1.8.0
Preparing search index...
types/fmWeb
FmWebLayoutLoadResult
Interface FmWebLayoutLoadResult
interface
FmWebLayoutLoadResult
{
layout
:
{
schemaVersion
:
1
;
id
:
string
;
name
:
string
;
fmLayoutName
?:
string
;
fieldOrder
?:
string
[]
;
canvas
:
{
width
:
number
;
height
:
number
;
gridSize
:
number
}
;
objects
:
(
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
;
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"field"
;
fmFieldName
:
string
;
displayType
:
"editBox"
|
"dropdown"
|
"checkbox"
|
"radio"
;
format
:
"number"
|
"text"
|
"date"
;
kind
?:
"global"
|
"normal"
|
"calculation"
|
"summary"
|
"container"
;
metadata
?:
{
type
?:
string
;
result
?:
string
}
;
result
?:
string
;
multiline
?:
boolean
;
options
?:
string
[]
;
label
?:
string
;
labelPosition
:
"none"
|
"top"
|
"right"
|
"left"
;
required
:
boolean
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
;
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"text"
;
text
:
string
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
;
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"button"
;
label
:
string
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
;
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"portal"
;
relatedContext
:
string
;
rowCount
:
number
;
columns
:
{
id
:
string
;
fmFieldName
:
string
;
label
:
string
;
width
:
number
;
}
[]
;
scroll
:
boolean
;
selectableRows
:
boolean
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
;
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"rectangle"
;
cornerRadius
:
number
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
;
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"image"
;
src
?:
string
;
alt
?:
string
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
;
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"tabPanel"
;
tabs
:
{
id
:
string
;
label
:
string
}
[]
;
}
)
[]
;
styles
:
{
colors
:
{
canvas
:
string
;
surface
:
string
;
text
:
string
;
accent
:
string
;
}
;
typography
:
{
fontFamily
:
string
;
fontSize
:
number
}
;
}
;
}
;
source
:
"created"
|
"existing"
;
filePath
:
string
;
}
Index
Properties
layout
source
file
Path
Properties
layout
layout
:
{
schemaVersion
:
1
;
id
:
string
;
name
:
string
;
fmLayoutName
?:
string
;
fieldOrder
?:
string
[]
;
canvas
:
{
width
:
number
;
height
:
number
;
gridSize
:
number
}
;
objects
:
(
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"field"
;
fmFieldName
:
string
;
displayType
:
"editBox"
|
"dropdown"
|
"checkbox"
|
"radio"
;
format
:
"number"
|
"text"
|
"date"
;
kind
?:
"global"
|
"normal"
|
"calculation"
|
"summary"
|
"container"
;
metadata
?:
{
type
?:
string
;
result
?:
string
}
;
result
?:
string
;
multiline
?:
boolean
;
options
?:
string
[]
;
label
?:
string
;
labelPosition
:
"none"
|
"top"
|
"right"
|
"left"
;
required
:
boolean
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"text"
;
text
:
string
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"button"
;
label
:
string
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"portal"
;
relatedContext
:
string
;
rowCount
:
number
;
columns
:
{
id
:
string
;
fmFieldName
:
string
;
label
:
string
;
width
:
number
;
}
[]
;
scroll
:
boolean
;
selectableRows
:
boolean
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"rectangle"
;
cornerRadius
:
number
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"image"
;
src
?:
string
;
alt
?:
string
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"tabPanel"
;
tabs
:
{
id
:
string
;
label
:
string
}
[]
;
}
)
[]
;
styles
:
{
colors
:
{
canvas
:
string
;
surface
:
string
;
text
:
string
;
accent
:
string
;
}
;
typography
:
{
fontFamily
:
string
;
fontSize
:
number
}
;
}
;
}
Type Declaration
schemaVersion
:
1
id
:
string
name
:
string
Optional
fmLayoutName
?:
string
Optional
fieldOrder
?:
string
[]
The field names of the FileMaker layout, in the order that layout shows them.
canvas
:
{
width
:
number
;
height
:
number
;
gridSize
:
number
}
objects
:
(
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"field"
;
fmFieldName
:
string
;
displayType
:
"editBox"
|
"dropdown"
|
"checkbox"
|
"radio"
;
format
:
"number"
|
"text"
|
"date"
;
kind
?:
"global"
|
"normal"
|
"calculation"
|
"summary"
|
"container"
;
metadata
?:
{
type
?:
string
;
result
?:
string
}
;
result
?:
string
;
multiline
?:
boolean
;
options
?:
string
[]
;
label
?:
string
;
labelPosition
:
"none"
|
"top"
|
"right"
|
"left"
;
required
:
boolean
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"text"
;
text
:
string
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"button"
;
label
:
string
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"portal"
;
relatedContext
:
string
;
rowCount
:
number
;
columns
:
{
id
:
string
;
fmFieldName
:
string
;
label
:
string
;
width
:
number
}
[]
;
scroll
:
boolean
;
selectableRows
:
boolean
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"rectangle"
;
cornerRadius
:
number
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"image"
;
src
?:
string
;
alt
?:
string
;
}
|
{
id
:
string
;
name
:
string
;
x
:
number
;
y
:
number
;
width
:
number
;
height
:
number
;
zIndex
:
number
;
anchors
:
{
top
:
boolean
;
right
:
boolean
;
bottom
:
boolean
;
left
:
boolean
}
;
style
?:
{
token
:
string
}
;
behavior
?:
{
type
?:
|
"runScript"
|
"goToWebLayout"
|
"goToFmLayout"
|
"openUrl"
|
"showDialog"
;
scriptName
?:
string
;
targetLayoutId
?:
string
;
targetFmLayoutName
?:
string
;
url
?:
string
;
dialogId
?:
string
;
parameter
?:
string
;
}
;
type
:
"tabPanel"
;
tabs
:
{
id
:
string
;
label
:
string
}
[]
;
}
)
[]
styles
:
{
colors
:
{
canvas
:
string
;
surface
:
string
;
text
:
string
;
accent
:
string
;
}
;
typography
:
{
fontFamily
:
string
;
fontSize
:
number
}
;
}
source
source
:
"created"
|
"existing"
file
Path
filePath
:
string
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
layout
source
file
Path
FileMaker Data API Tools API - v1.8.0
Loading...
The field names of the FileMaker layout, in the order that layout shows them.