Seating map layout

These five tools still attach a visual drawing to a seating map. They are obsolete. Prefer createTemplate (seating chart kind from getTemplateSchema), getTemplate, insertTemplateNodes, updateTemplateNode, and removeTemplateNode, then set the map templateId with updateSeatingChart. Open the seating-map-layout guide for node rules (LAYER, TEXT, SEAT with x, y, and rotation; a SEAT should include capacityNodeId).

createSeatingMapLayout

Obsolete. Prefer createTemplate (seating chart kind from getTemplateSchema) and set the map template id. Create a visual layout for a seating map that does not have one yet. The layout starts empty. Does not go live for guests.

ArgumentTypeRequiredDescription
seatingChartIdstringYesSeating map id
namestringNoName of the layout. Defaults to the seating map name.

Fails if the map already has a layout.

getSeatingMapLayout

Obsolete. Prefer getTemplate on the map template id. Get the working copy of a seating map layout: LAYER, TEXT, and SEAT nodes with their ids, x, y, and rotation. If the map has no layout yet, templateId is null.

ArgumentTypeRequiredDescription
seatingChartIdstringYesSeating map id

insertSeatingMapNodes

Obsolete. Prefer insertTemplateNodes. Insert one or many layout nodes in a single change. Use this for a whole row of seats. Each node is LAYER, TEXT, or SEAT with x, y, and rotation. A SEAT should include capacityNodeId.

ArgumentTypeRequiredDescription
seatingChartIdstringYesSeating map id
nodesarrayYesList of nodes to insert. LAYER may include children. TEXT and SEAT are leaves.
parentIdstringNoParent node id. Omit or pass null to insert at the root.
indexintegerNoPosition among siblings. Omit to append.

Requires an existing layout. Returns the working copy plus insertedNodeIds.

updateSeatingMapNode

Obsolete. Prefer updateTemplateNode. Change one layout node. Only the fields you pass change. Use for x, y, rotation, capacity, text, name, or hide.

ArgumentTypeRequiredDescription
seatingChartIdstringYesSeating map id
nodeIdstringYesLayout node id
xnumberNoX position
ynumberNoY position
rotationnumberNoRotation in degrees
capacityNodeIdstringNoCapacity on the sellable tree this seat draws. Pass null to clear.
textstringNoText for a TEXT node
languagestringNoLanguage for text. Defaults to en.
namestringNoDisplay name in the layout tree
hidebooleanNoHide or show the node

removeSeatingMapNode

Obsolete. Prefer removeTemplateNode. Remove one node from a seating map layout, including its children.

ArgumentTypeRequiredDescription
seatingChartIdstringYesSeating map id
nodeIdstringYesLayout node id
Previous
Guides