ReadonlytypeWhat the object represents.
The vendor types this as the DashboardObjectType enum, whose values are
'blank', 'worksheet', 'quick-filter', 'parameter-control',
'page-filter', 'legend', 'title', 'text', 'image', 'web-page'
and 'extension'. It is widened to string here deliberately: the enum is
closed in this contract version, the host page loads whichever Embedding
build it likes, and the adapter only ever asks whether the value is
'worksheet' — a union would invite an exhaustive switch over a set that
is not actually closed at runtime.
ReadonlypositionCoordinates relative to the top-left corner of the containing dashboard.
ReadonlysizeThe object's own size, in the same pixel space as position.
ReadonlyworksheetThe worksheet when type is 'worksheet', undefined otherwise.
ReadonlynameThe name given to the object during authoring.
Not a worksheet name, even for a worksheet object: an author can rename
the container without renaming the sheet inside it. Matching geometry to a
worksheet goes through object.worksheet.name, never through this.
ReadonlyisTrue when the object floats rather than sitting in the tiled layout.
ReadonlyisTrue when the object is visible.
ReadonlyidThe dashboard object's id.
One object placed on a dashboard: a worksheet, a legend, a title, a blank.
Mirrors
DashboardObjectinExternalContract/Embedding/SheetInterfaces.d.ts(@tableau/api-external-contract-js@1.211.0), member for member, minus thedashboardback-reference — that member exists, and is omitted here only because nothing reads it and mirroring it would make this file's two dashboard types mutually recursive for no gain.Every member is required and non-optional in the declarations, and none carries an
@sincetag, so the contract sets no version floor: presence at runtime is the only test that means anything. See TableauDashboard.objects.