@graphty/graph-io / styles / StyleNote

Interface: StyleNote

Defined in: styles/types.ts:1178

One aggregated note: everything approximated, dropped or malformed for one code, target and property.

Properties

code

readonly code: StyleNoteCode

Defined in: styles/types.ts:1180

The condition.

---

elements?

readonly optional elements?: readonly number[] | { count: number; }

Defined in: styles/types.ts:1196

The element indexes the note covers, sorted, when every occurrence named one; otherwise only how many occurrences there were.

Union Members

readonly number[]

---

Type Literal

{ count: number; }

count

readonly count: number

How many occurrences there were.

---

message

readonly message: string

Defined in: styles/types.ts:1203

English for graph-io's own report; an application writes its own words from the code and params.

---

params

readonly params: object

Defined in: styles/types.ts:1182

The facts.

count

readonly count: number

How many times the condition occurred.

property

readonly property: string | null

The property (or the file's own name for the construct) the note is about, or null.

samples

readonly samples: readonly string[]

Up to 8 distinct examples, each at most 80 characters.

target

readonly target: "graph" | StyleTarget | null

Nodes, edges, the graph, or null for the file as a whole.