aalekh-analysis/com.aalekh.aalekh.analysis.graph/PresentationProfile

PresentationProfile

enum PresentationProfile : Enum<PresentationProfile> (source)

How big a project is, and therefore how it should be presented.

A force-directed graph is the clearest possible picture of thirty modules and the least useful picture of five hundred. The failure is not the layout algorithm - it is drawing five hundred of anything at once. So the report changes what it draws with size rather than trying to make one view survive every scale.

The governing principle: at every size, the landing view must be readable without interaction. A diagram that only becomes useful after zooming has already failed the reader who opened it to find out what the project is.

Entries

DETAIL

Small enough to draw every module and every edge at once.

GROUPED

Regions first, with a module-level graph one click away.

SURVEY

Regions and flows only; module-level views exist but are reached by search, not by scrolling.

ATLAS

Too large for any global node-link view. Orientation comes from regions and search; the graph is only ever drawn around a module the reader asked for.

Types

Companion

object Companion

Properties

allowsGlobalGraph

val allowsGlobalGraph: Boolean

Whether a global module-level force graph is worth offering at all.

entries

val entries: EnumEntries<PresentationProfile>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

landingView

val landingView: String

The view the report should open on.

name

val name: String

ordinal

val ordinal: Int

rationale

val rationale: String

One line explaining to the reader why they are seeing this view first.

Functions

valueOf

fun valueOf(value: String): PresentationProfile

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<PresentationProfile>

Returns an array containing the constants of this enum type, in the order they're declared.