pivotick v3.0.0

---

pivotic / GraphUI / LegendOptions

Interfaz: LegendOptions

Definido en: interfaces/GraphUI.ts:668

UI.legend — la leyenda del lienzo. Es descriptivo: reporta los colores el renderizador ya resolvió y nunca asigna uno, por lo que el consumidor sigue siendo el único propietario de la coloración de los nodos.

Las entradas provienen de key (derivadas de los datos, muestras tomadas del renderizador), de entries (declarado), o de ambos - key luego suministra el Predicado predeterminado para entradas que no lo llevan.

Con ninguno, la leyenda se coloca en render.nodeTypeAccessor (el dimensión que ya declaró para nodeStyleMap), pero solo después de verificar que esta dimensión es realmente la dimensión del color: cada categoría debe resolver para exactamente un color, debe haber al menos dos de ellos, y pocos de ellos que sean categorías. Ese chequeo es lo que hace segura una leyenda que nadie pidió; UI.legend: true lo omite, false suprime la leyenda por completo.

Para codificar un gráfico en más de una dimensión a la vez, pase LegendGroupOptions en su lugar.

Se muestra solo en los modos full y light.

Ejemplo

UI: { legend: { key: 'type', title: 'Node type' } }

Se extiende

• LegendSection

Propiedades

collapsed?

optional collapsed: boolean

Definido en: interfaces/GraphUI.ts:626

Inicio colapsado.

Predeterminado

false

Heredado de

LegendSection.collapsed

---

collapsible?

optional collapsible: boolean

Definido en: interfaces/GraphUI.ts:624

Predeterminado

true

Heredado de

LegendSection.collapsible

---

enabled?

optional enabled: boolean

Definido en: interfaces/GraphUI.ts:586

Predeterminado

true when the block is present

Heredado de

LegendSection.enabled

---

entries?

optional entries: LegendEntry[] | (graph) => LegendEntry[]

Definido en: interfaces/GraphUI.ts:622

Entradas declaradas, o una función que se vuelve a resolver contra el gráfico en vivo cada momento en que se reconstruye la leyenda (para que la lista pueda seguir los datos).

Heredado de

LegendSection.entries

---

filterable?

optional filterable: boolean

Definido en: interfaces/GraphUI.ts:630

Al hacer clic en una entrada se filtra el gráfico. false representa una clave pura.

Predeterminado

true

Heredado de

LegendSection.filterable

---

highlightOnHover?

optional highlightOnHover: boolean

Definido en: interfaces/GraphUI.ts:637

Al pasar el cursor sobre una entrada se lee su categoría en el lienzo: los elementos que representa mantengan su mirada, todo lo demás se atenúa hasta que el puntero se va. Funciona en un Tecla filterable: false también: señalar una categoría no pregunta nada al gráfico.

Predeterminado

true

Heredado de

LegendSection.highlightOnHover

---

id?

optional id: string

Definido en: interfaces/GraphUI.ts:605

Identidad estable: la clave de filtro propia de la sección (__legend:<id>) y la section campo del evento legendToggle.

Predeterminado

key, si no section-<index>

Heredado de

LegendSection.id

---

key?

optional key: string

Definido en: interfaces/GraphUI.ts:617

Modo derivado: la clave de datos cuyos valores distintos se convierten en las entradas, cada una muestra tomada del estilo resuelto del renderizador. Leer nodos o bordes cuando scope es 'edge'. También proporciona el predicado predeterminado cuando entries se declaran sin uno.

Heredado de

LegendSection.key

---

maxVisibleEntries?

optional maxVisibleEntries: number

Definido en: interfaces/GraphUI.ts:639

Entradas que se muestran antes de que se desplace la lista.

Predeterminado

12

Heredado de

LegendSection.maxVisibleEntries

---

position?

optional position: LegendPosition

Definido en: interfaces/GraphUI.ts:675

En qué esquina se acopla. En el modo full, el valor predeterminado es la columna derecha, apilado encima del minimapa: el de la izquierda pertenece al carril de modo y su paneles. Otros modos mantienen la esquina inferior izquierda.

Predeterminado

'abajo a la derecha' en modo full, 'bottom-left' en caso contrario

---

scope?

optional scope: LegendScope

Definido en: interfaces/GraphUI.ts:599

En qué colección se centra esta sección. 'edge' enumera la relación del gráfico tipos con una muestra de línea: color de trazo, guión y marcador como renderizador los resolvió, y su botón oculta el borde capas: los nodos permanecen en su lugar, y así Haz el diseño, la selección y la cámara.

Una sección edge filtra si UI.filter.edgeFacets declara o no su Clave: dada una, controla esa faceta, por lo que el panel y la leyenda son dos vistas. de un filtro; sin uno, se reserva una faceta propia.

Predeterminado

'node'

Heredado de

LegendSection.scope

---

showCounts?

optional showCounts: boolean

Definido en: interfaces/GraphUI.ts:628

Muestra un recuento de elementos por entrada.

Predeterminado

true

Heredado de

LegendSection.showCounts

---

title?

optional title: string

Definido en: interfaces/GraphUI.ts:610

Texto del encabezado, usado palabra por palabra (para que pueda traducirse).

Predeterminado

un bonito key, si no 'Legend'

Heredado de

LegendSection.title