pivotick v3.0.0

---

draaipunt / GraphUI / RailModeDefinition

Interface: RailModeDefinition

Gedefinieerd in: interfaces/GraphUI.ts:440

Een modus geregistreerd op de moderail – de deur die een integrator zelf bouwt Verken of verrijk de modus via.

Geregistreerde modi worden weergegeven onder een scheidingslijn, na de vier ingebouwde modi, geordend op bestelling. Registreer er op elk moment in de levensduur van de grafiek een graph.UIManager.addRailMode(), of via install van een plug-in via ctx.addRailMode(). Ofwel retourneert een ontdoener.

Een 'pointer'-modus is eigenaar van het contextuele gereedschapspaneel: deze declareert tools, en kan voeg iets anders toe via render. Een 'flyout'-modus levert in plaats daarvan a flyout fabriek waarvan het paneel wordt geopend terwijl de modus actief is.

Voorbeeld

const dispose = graph.UIManager.addRailMode({
    id: 'explore', label: 'Explore', icon: compassSvg, shortcut: 'E',
    tools: [{ id: 'expand', label: 'Expand', icon: plusSvg, kind: 'action', run: () => … }],
})

Eigenschappen

defaultTool?

optional defaultTool: string | null

Gedefinieerd in: interfaces/GraphUI.ts:469

De tool waarop deze modus rust als er niets is ingeschakeld.

Standaard

null

---

flyout()?

optional flyout: (ui) => Flyout

Gedefinieerd in: interfaces/GraphUI.ts:515

Bouwt het vervolgpaneel van deze modus. Vereist voor kind: 'flyout' en genegeerd anders. Het paneel wordt in de uitklapsleuf gemonteerd en met de modus afgebroken; de eigen mode van de subklasse moet gelijk zijn aan de id van deze definitie.

Parameters

ui

UIManager

Retouren

Flyout

---

icon

icon: string

Gedefinieerd in: interfaces/GraphUI.ts:449

Een string SVG, geïnjecteerd met innerHTML en niet opgeschoond — deze moet vertrouwd. CSS verkleint het naar 20px op de rail.

---

id

id: string

Gedefinieerd in: interfaces/GraphUI.ts:442

Stabiele identiteit: wat de winkel bevat, en de data-mode op de spoorknop.

---

keepPanelOpen?

optional keepPanelOpen: boolean

Gedefinieerd in: interfaces/GraphUI.ts:499

Houd het paneel open als een van de tools van deze modus is ingeschakeld. Normaal inschakelen vouwt het paneel samen zodat het canvas helder is - goed voor Select's Lasso, verkeerd voor a modus waarvan het paneel is de werkruimte is en waarvan de tools alleen aangeven hoe deze moet worden ingevoerd.

Standaard

false

---

kind?

optional kind: "pointer" | "flyout"

Gedefinieerd in: interfaces/GraphUI.ts:455

'pointer' modi bezitten het gereedschapspaneel; 'flyout' modi openen een instellingen-overlay en hebben geen gereedschap.

Standaard

'pointer'

---

label

label: string

Gedefinieerd in: interfaces/GraphUI.ts:444

Het label van de railknop, woordelijk gebruikt.

---

onEnter()?

optional onEnter: () => void

Gedefinieerd in: interfaces/GraphUI.ts:517

Wordt opgeroepen wanneer de modus actief wordt.

Retouren

void

---

onExit()?

optional onExit: () => void

Gedefinieerd in: interfaces/GraphUI.ts:523

Wordt aangeroepen wanneer de modus wordt verlaten en wanneer deze niet meer wordt geregistreerd terwijl deze actief is. Ontwapenen ongeacht de modus die hier is ingeschakeld. Er is geen beroep gedaan op demontage van de gebruikersinterface: gebruik de ontdoeners van uw plug-in houdt daar al rekening mee.

Retouren

void

---

order?

optional order: number

Gedefinieerd in: interfaces/GraphUI.ts:467

Weergavevolgorde tussen geregistreerde modi, oplopend. Gelijke bestellingen behouden de registratie bestelling. Heeft geen invloed op de ingebouwde modi, die komen altijd op de eerste plaats.

Standaard

0

---

panelOpen?

optional panelOpen: boolean

Gedefinieerd in: interfaces/GraphUI.ts:475

Of het toolpaneel wordt uitgevouwen wanneer de modus voor het eerst wordt geopend. Standaard ingesteld op open zodat de tools van de modus vindbaar zijn.

Standaard

true

---

panelResizable?

optional panelResizable: boolean

Gedefinieerd in: interfaces/GraphUI.ts:492

Laat de analist het paneel van deze modus aan de rechterkant breder of smaller slepen.

Standaard uitgeschakeld: een paneel met pictogramrijen heeft één rechterbreedte en een handvat daarop is a controle zonder iets te doen. Een modus waarvan het paneel de werkruimte is: een formulier, een lijst, een reeks resultaten – is waar de keuze de moeite waard is om aan te bieden. De breedte wordt onthouden per modus voor de sessie en wordt niet voortgezet, dus er wordt opnieuw geladen panelWidth opnieuw.

Standaard

false

---

panelWidth?

optional panelWidth: number

Gedefinieerd in: interfaces/GraphUI.ts:481

Hoe breed het toolpaneel van deze modus is, in pixels. Door de inbouwbreedte past er een rij van pictogram + label; een modus waarvan het render slot een formulier of een lijst bevat, heeft meer nodig.

Standaard

216

---

render()?

optional render: () => HTMLElement

Gedefinieerd in: interfaces/GraphUI.ts:509

Extra paneelinhoud, onder toegevoegd aan de gereedschapsrijen: een schuifregelaar, een zoekvak, alles wat de rijen niet kunnen uitdrukken. Opnieuw aangeroepen wanneer het paneel opnieuw wordt opgebouwd.

Retouren

HTMLElement

---

shortcut?

optional shortcut: string

Gedefinieerd in: interfaces/GraphUI.ts:461

Een enkele toets die de modus activeert, of het paneel schakelt wanneer dit al het geval is actief. Geregistreerd via de normale keybinding manager, dus een sleutel is al gebonden in de schaduw gesteld (met een waarschuwing) totdat deze modus wordt verwijderd.

---

tools?

optional tools: RailTool[] | () => RailTool[]

Gedefinieerd in: interfaces/GraphUI.ts:504

De gereedschappen van de modus, als rijen in het paneel. Geef een functie door wanneer de set afhankelijk is van de huidige selectie of gegevens; het wordt bij elke weergave opnieuw gelezen.