entviz — @entviz/core & @entviz/react API
    Preparing search index...

    Interface EntvizProps

    @entviz/react — React components over the certified @entviz/core renderer.

    Ships raw .ts source (no build step); authored with React.createElement so it carries no JSX-transform requirement onto consumers.

    interface EntvizProps {
        className?: string;
        controls?: boolean;
        fontSizePt?: number;
        locale?: string;
        messages?: Messages;
        note?: string | null;
        onError?: (message: string) => void;
        onEvent?: (e: EntvizEvent) => void;
        onReshape?: (targetAr: number) => void;
        onResize?: (fontSizePt: number) => void;
        reshapable?: boolean;
        style?: CSSProperties;
        targetAr?: number;
        title?: string;
        value: string;
    }
    Index
    className? controls? fontSizePt? locale? messages? note? onError? onEvent? onReshape? onResize? reshapable? style? targetAr? title? value
    className?: string

    Extra props applied to the wrapping element (className, style, …).

    controls?: boolean

    Show opt-in, suppressible size (font-size ladder) + reshape controls beside the figure. Off by default — the bare component stays a pure render.

    fontSizePt?: number

    Reference font size in points (default 12).

    locale?: string

    BCP-47 locale for the controls toolbar chrome (size/shape/copy labels + copy toasts). Auto-detected from the browser when omitted. Ignored when controls is off (the bare figure has no chrome).

    messages?: Messages

    Pre-resolved chrome messages for the toolbar, overriding locale. <EntvizPill> passes its own resolved bundle down so the embedded toolbar matches the pill.

    note?: string | null

    Optional out-of-band caption (≤10 printable-ASCII chars, U+0020–U+007E).

    onError?: (message: string) => void

    Called with the error message if rendering throws (e.g. bad note).

    onEvent?: (e: EntvizEvent) => void

    The typed event firehose (see events.ts). Notify-only, in addition to the specific callbacks (render.error / display.resize / display.reshape / copy).

    onReshape?: (targetAr: number) => void

    Reshape handler. When given, the aspect ratio is CONTROLLED; otherwise managed internally. Receives the targetAr of the chosen grid shape.

    onResize?: (fontSizePt: number) => void

    Resize handler. When given, font size is CONTROLLED (the parent owns it — e.g. the comparator drives both figures); otherwise it is managed internally.

    reshapable?: boolean

    Whether the reshape (grid-shape) control is offered when controls is on (default true). The comparator turns this off for a raster reference, which can't be re-rendered into a different shape.

    style?: CSSProperties
    targetAr?: number

    Target aspect ratio W/H (default 1.0).

    title?: string

    Accessible label; defaults to a description that includes the note.

    value: string

    The high-entropy value to visualize (key, hash, UUID, address, …).

    Settings
    Member Visibility

    On This Page
    Properties