Palette
Defined in: export/Palette.ts:10
A palette shows templates that can be dragged onto a diagram. Dragging a template item onto the diagram adds a new node.
Constructors
Sección titulada «Constructors»Constructor
Sección titulada «Constructor»new Palette(
container,diagram?,templates?,options?):Palette
Defined in: export/Palette.ts:17
Parameters
Sección titulada «Parameters»container
Sección titulada «container»HTMLElement
diagram?
Sección titulada «diagram?»templates?
Sección titulada «templates?»Template[]
options?
Sección titulada «options?»showCategories?
Sección titulada «showCategories?»boolean
Returns
Sección titulada «Returns»Palette
Methods
Sección titulada «Methods»destroy()
Sección titulada «destroy()»destroy():
void
Defined in: export/Palette.ts:170
Destroy the palette and clean up.
Returns
Sección titulada «Returns»void
getDiagram()
Sección titulada «getDiagram()»getDiagram():
Diagram
Defined in: export/Palette.ts:55
Get the diagram this palette is connected to.
Returns
Sección titulada «Returns»getElement()
Sección titulada «getElement()»getElement():
HTMLDivElement
Defined in: export/Palette.ts:50
Get the palette DOM element.
Returns
Sección titulada «Returns»HTMLDivElement
handleDropOnDiagram()
Sección titulada «handleDropOnDiagram()»handleDropOnDiagram(
templateId,diagramX,diagramY):NodeData|null
Defined in: export/Palette.ts:157
Handle a drop of a template onto the diagram. Called externally by the diagram’s drop handling.
Parameters
Sección titulada «Parameters»templateId
Sección titulada «templateId»string
diagramX
Sección titulada «diagramX»number
diagramY
Sección titulada «diagramY»number
Returns
Sección titulada «Returns»NodeData | null
setTemplates()
Sección titulada «setTemplates()»setTemplates(
templates):void
Defined in: export/Palette.ts:60
Set the templates shown in this palette.
Parameters
Sección titulada «Parameters»templates
Sección titulada «templates»Template[]
Returns
Sección titulada «Returns»void