Reference NutrientViewerOutlineElement

Class OutlineElement

This record is used to represent document outline elements. These allow the user to navigate interactively from one part of the document to another.

Outline elements can be nested in a tree-like structure where elements are collapsible/expandable to hide/reveal their subtrees.

Class

Hierarchy

RecordOutlineElement

Constructors

new OutlineElement(values)

Parameters
values
Partial<{ … }>Partial<
    {
        action: NutrientViewer.Actions.Action
        | null;
        children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
        color: NutrientViewer.Color | null;
        isBold: boolean;
        isExpanded: boolean;
        isItalic: boolean;
        title: string;
    },
>
Optional
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).constructor

Properties

action

Readonly

NutrientViewer.Actions.Action | null

The action that will be triggered when the outline element is either clicked or tapped.

Please refer to NutrientViewer.Actions for an in-depth look at PDF actions.

children

Readonly

NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>

Each outline element can have nested outline elements. The visibility of which is controlled by OutlineElement.isExpanded.

color

Readonly

NutrientViewer.Color | null

The text color of the outline element title. When this value is null the color is the Nutrient Web SDK's UI's default color which can be configured via NutrientViewer's public CSS API.

Default Value

null

isBold

Readonly

boolean

Whether the outline element title is bold.

Default Value

false

isExpanded

Readonly

boolean

Whether the outline element is expanded and shows its child elements.

Default Value

false

isItalic

Readonly

boolean

Whether the outline element title is italic.

Default Value

false

title

Readonly

string

The outline element title, must be human readable.

Immutable Record API

displayName

Static

string

The name provided to Record(values, name) can be accessed with displayName.

[iterator]

"[iterator]"(): IterableIterator<
    [
        keyof { … },
        | string
        | boolean
        | NutrientViewer.Color
        | NutrientViewer.Actions.Action
        | NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
        | null,
    ],
>"[iterator]"(): IterableIterator<
    [
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
        | string
        | boolean
        | NutrientViewer.Color
        | NutrientViewer.Actions.Action
        | NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
        | null,
    ],
>
Returns
IterableIterator<
[
keyof { … },
| string
| boolean
| NutrientViewer.Color
| NutrientViewer.Actions.Action
| NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
| null
]
>IterableIterator<
    [
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
        | string
        | boolean
        | NutrientViewer.Color
        | NutrientViewer.Actions.Action
        | NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
        | null,
    ],
>
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).[iterator]

asImmutable

asImmutable(): this
Returns
this
See Also
Map#asImmutable
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).asImmutable

asMutable

asMutable(): this
Returns
this
See Also
Map#asMutable
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).clear

delete

delete<K extends keyof { … }>(key: K): thisdelete<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
>(
    key: K,
): this
Returns a new instance of this Record type with the value for the specific key set to its default value.

Type Parameters
K
extends keyof { … }extends keyof {
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).equals

get

get<K extends keyof { … }>(key: K, notSetValue?: unknown): { … }[K]get<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
>(
    key: K,
    notSetValue?: unknown,
): {
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.

Type Parameters
K
extends keyof { … }extends keyof {
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
Parameters
keyK
notSetValueunknown
Optional
Returns
{ … }[K]{
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}[K]
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).get
get<T>(key: string, notSetValue: T): T
Type Parameters
T
Parameters
keystring
notSetValueT
Returns
T
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).get

getIn

getIn(keyPath: Iterable<unknown>): unknown
Parameters
keyPathIterable<unknown>
Returns
unknown
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).getIn

has

has(
    key: string,
): key is
    | "action"
    | "color"
    | "title"
    | "isBold"
    | "isItalic"
    | "children"
    | "isExpanded"
Parameters
keystring
Returns
key is
| "action"
| "color"
| "title"
| "isBold"
| "isItalic"
| "children"
| "isExpanded"
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).has

hashCode

hashCode(): number
Returns
number
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).hashCode

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Parameters
keyPathIterable<unknown>
Returns
boolean
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).hasIn

merge

merge(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismerge(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                action: NutrientViewer.Actions.Action
                | null;
                children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
                color: NutrientViewer.Color | null;
                isBold: boolean;
                isExpanded: boolean;
                isItalic: boolean;
                title: string;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                action: NutrientViewer.Actions.Action
                | null;
                children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
                color: NutrientViewer.Color | null;
                isBold: boolean;
                isExpanded: boolean;
                isItalic: boolean;
                title: string;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
    merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                action: NutrientViewer.Actions.Action
                | null;
                children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
                color: NutrientViewer.Color | null;
                isBold: boolean;
                isExpanded: boolean;
                isItalic: boolean;
                title: string;
            },
        >
    )[],
): this
Parameters
merger(oldVal: unknown, newVal: unknown, key: unknown) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).mergeIn

mergeWith

mergeWith(
    merger: (oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (
        oldVal: unknown,
        newVal: unknown,
        key: keyof {
            action: NutrientViewer.Actions.Action | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
    ) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                action: NutrientViewer.Actions.Action
                | null;
                children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
                color: NutrientViewer.Color | null;
                isBold: boolean;
                isExpanded: boolean;
                isItalic: boolean;
                title: string;
            },
        >
    )[],
): this
Parameters
merger
(oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown(
    oldVal: unknown,
    newVal: unknown,
    key: keyof {
        action: NutrientViewer.Actions.Action | null;
        children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
        color: NutrientViewer.Color | null;
        isBold: boolean;
        isExpanded: boolean;
        isItalic: boolean;
        title: string;
    },
) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
    >
)[]
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).mergeWith

remove

remove<K extends keyof { … }>(key: K): thisremove<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
>(
    key: K,
): this
Type Parameters
K
extends keyof { … }extends keyof {
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).removeIn

set

set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
>(
    key: K,
    value: {
        action: NutrientViewer.Actions.Action | null;
        children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
        color: NutrientViewer.Color | null;
        isBold: boolean;
        isExpanded: boolean;
        isItalic: boolean;
        title: string;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
Parameters
keyK
value
{ … }[K]{
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}[K]
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).setIn

toJS

toJS(): { … }toJS(): {
    action: unknown;
    children: unknown;
    color: unknown;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.
Returns
{ … }{
    action: unknown;
    children: unknown;
    color: unknown;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
action: unknown
The action that will be triggered when the outline element is either clicked or tapped.

Please refer to NutrientViewer.Actions for an in-depth look at PDF actions.

children: unknown
Each outline element can have nested outline elements. The visibility of which is controlled by OutlineElement.isExpanded.

See Also
Instance#getDocumentOutline

color: unknown
The text color of the outline element title. When this value is null the color is the Nutrient Web SDK's UI's default color which can be configured via NutrientViewer's public CSS API.

Default Value
null
isBold: boolean
Whether the outline element title is bold.

Default Value
false
isExpanded: boolean
Whether the outline element is expanded and shows its child elements.

Default Value
false
isItalic: boolean
Whether the outline element title is italic.

Default Value
false
title: string
The outline element title, must be human readable.
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).toJS

toJSON

toJSON(): { … }toJSON(): {
    action: NutrientViewer.Actions.Action
    | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
Shallowly converts this Record to equivalent native JavaScript Object.
Returns
{ … }{
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
action: NutrientViewer.Actions.Action | null
The action that will be triggered when the outline element is either clicked or tapped.

Please refer to NutrientViewer.Actions for an in-depth look at PDF actions.

children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
Each outline element can have nested outline elements. The visibility of which is controlled by OutlineElement.isExpanded.

See Also
Instance#getDocumentOutline

color: NutrientViewer.Color | null
The text color of the outline element title. When this value is null the color is the Nutrient Web SDK's UI's default color which can be configured via NutrientViewer's public CSS API.

Default Value
null
isBold: boolean
Whether the outline element title is bold.

Default Value
false
isExpanded: boolean
Whether the outline element is expanded and shows its child elements.

Default Value
false
isItalic: boolean
Whether the outline element title is italic.

Default Value
false
title: string
The outline element title, must be human readable.
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).toJSON

toObject

toObject(): { … }toObject(): {
    action: NutrientViewer.Actions.Action
    | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
Shallowly converts this Record to equivalent JavaScript Object.
Returns
{ … }{
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
action: NutrientViewer.Actions.Action | null
The action that will be triggered when the outline element is either clicked or tapped.

Please refer to NutrientViewer.Actions for an in-depth look at PDF actions.

children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
Each outline element can have nested outline elements. The visibility of which is controlled by OutlineElement.isExpanded.

See Also
Instance#getDocumentOutline

color: NutrientViewer.Color | null
The text color of the outline element title. When this value is null the color is the Nutrient Web SDK's UI's default color which can be configured via NutrientViewer's public CSS API.

Default Value
null
isBold: boolean
Whether the outline element title is bold.

Default Value
false
isExpanded: boolean
Whether the outline element is expanded and shows its child elements.

Default Value
false
isItalic: boolean
Whether the outline element title is italic.

Default Value
false
title: string
The outline element title, must be human readable.
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).toObject

toSeq

toSeq(): Keyed<
    keyof { … },
    | string
    | boolean
    | NutrientViewer.Color
    | NutrientViewer.Actions.Action
    | NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
    | null,
>toSeq(): Keyed<
    keyof {
        action: NutrientViewer.Actions.Action
        | null;
        children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
        color: NutrientViewer.Color | null;
        isBold: boolean;
        isExpanded: boolean;
        isItalic: boolean;
        title: string;
    },
    | string
    | boolean
    | NutrientViewer.Color
    | NutrientViewer.Actions.Action
    | NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
    | null,
>
Returns
Keyed<
keyof { … },
| string
| boolean
| NutrientViewer.Color
| NutrientViewer.Actions.Action
| NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
| null
>Keyed<
    keyof {
        action: NutrientViewer.Actions.Action
        | null;
        children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
        color: NutrientViewer.Color | null;
        isBold: boolean;
        isExpanded: boolean;
        isItalic: boolean;
        title: string;
    },
    | string
    | boolean
    | NutrientViewer.Color
    | NutrientViewer.Actions.Action
    | NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>
    | null,
>
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).toSeq

update

update<K extends keyof { … }>(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<
    K extends
        keyof {
            action: NutrientViewer.Actions.Action
            | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        },
>(
    key: K,
    updater: (
        value: {
            action: NutrientViewer.Actions.Action | null;
            children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
            color: NutrientViewer.Color | null;
            isBold: boolean;
            isExpanded: boolean;
            isItalic: boolean;
            title: string;
        }[K],
    ) => {
        action: NutrientViewer.Actions.Action
        | null;
        children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
        color: NutrientViewer.Color | null;
        isBold: boolean;
        isExpanded: boolean;
        isItalic: boolean;
        title: string;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    action: NutrientViewer.Actions.Action | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    value: {
        action: NutrientViewer.Actions.Action | null;
        children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
        color: NutrientViewer.Color | null;
        isBold: boolean;
        isExpanded: boolean;
        isItalic: boolean;
        title: string;
    }[K],
) => {
    action: NutrientViewer.Actions.Action
    | null;
    children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>;
    color: NutrientViewer.Color | null;
    isBold: boolean;
    isExpanded: boolean;
    isItalic: boolean;
    title: string;
}[K]
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).update

updateIn

updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).updateIn

wasAltered

wasAltered(): boolean
Returns
boolean
See Also
Map#wasAltered
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).wasAltered

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
mutator(mutable: this) => unknown
Returns
this
See Also
Map#withMutations
Inherited from ImmutableRecord<OutlineElementProps>({ children: List<OutlineElement>(), title: '', color: null, isBold: false, isItalic: false, isExpanded: false, action: null, }).withMutations

Class OutlineElement

Hierarchy

Constructors

Parameters

Properties

See Also

Default Value

Default Value

Default Value

Default Value

Immutable Record API

Returns

Returns

See Also

Returns

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

action: unknown

children: unknown

See Also

color: unknown

Default Value

isBold: boolean

Default Value

isExpanded: boolean

Default Value

isItalic: boolean

Default Value

title: string

Returns

action: NutrientViewer.Actions.Action | null

children: NutrientViewer.Immutable.List<NutrientViewer.OutlineElement>

See Also

color: NutrientViewer.Color | null

Default Value

isBold: boolean

Default Value