Reference NutrientViewerCallout

Class Callout

Properties of the arrow line attached to a callout (text) annotation.

Class

Hierarchy

InheritableImmutableRecordCallout

Constructors

new Callout(values)

Parameters
values
Partial<{ … }>Partial<
    {
        cap: | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
        end: NutrientViewer.Geometry.Point
        | null;
        innerRectInset: NutrientViewer.Geometry.Inset | null;
        knee: NutrientViewer.Geometry.Point | null;
        start: NutrientViewer.Geometry.Point | null;
    },
>
Optional
Inherited from InheritableImmutableRecord<ICallout>.constructor

Properties

cap

The line cap style.

end

NutrientViewer.Geometry.Point | null

Ending point of the arrow line.

innerRectInset

NutrientViewer.Geometry.Inset | null

The inner rectangle inset.

knee

NutrientViewer.Geometry.Point | null

Knee point of the arrow line.

start

NutrientViewer.Geometry.Point | null

Starting point of the arrow line.

defaultValues

Static

{ … }

Property	Description
cap
end
innerRectInset
knee
start

Immutable Record API

asImmutable

asImmutable(): this
Returns
this
See Also
Map#asImmutable
Inherited from InheritableImmutableRecord.asImmutable

asMutable

asMutable(): this
Returns
this
See Also
Map#asMutable
Inherited from InheritableImmutableRecord.asMutable

clear

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

Returns
this
Inherited from InheritableImmutableRecord.clear

delete

delete<K extends keyof { … }>(key: K): thisdelete<
    K extends
        keyof {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
>(
    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 {
    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}
Parameters
keyK
Returns
this
Inherited from InheritableImmutableRecord.delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from InheritableImmutableRecord.deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from InheritableImmutableRecord.equals

get

get<K extends keyof { … }>(key: K): { … }[K]get<
    K extends
        keyof {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
>(
    key: K,
): {
    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}[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 {
    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}
Parameters
keyK
Returns
{ … }[K]{
    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}[K]
Inherited from InheritableImmutableRecord.get

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
keyPathIterable<unknown>
notSetValueunknown
Optional
Returns
unknown
Inherited from InheritableImmutableRecord.getIn

has

has(key: unknown): boolean
Parameters
keyunknown
Returns
boolean
Inherited from InheritableImmutableRecord.has

merge

merge(...collections: Partial<{ … }>[]): thismerge(
    ...collections: Partial<
        {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
    >[],
): this
Parameters
...collections
Partial<{ … }>[]Partial<
    {
        cap: | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
        end: NutrientViewer.Geometry.Point
        | null;
        innerRectInset: NutrientViewer.Geometry.Inset | null;
        knee: NutrientViewer.Geometry.Point | null;
        start: NutrientViewer.Geometry.Point | null;
    },
>[]
Returns
this
Inherited from InheritableImmutableRecord.merge

mergeDeep

mergeDeep(
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                cap: | "square"
                | "circle"
                | "diamond"
                | "openArrow"
                | "closedArrow"
                | "butt"
                | "reverseOpenArrow"
                | "reverseClosedArrow"
                | "slash"
                | null;
                end: NutrientViewer.Geometry.Point
                | null;
                innerRectInset: NutrientViewer.Geometry.Inset | null;
                knee: NutrientViewer.Geometry.Point | null;
                start: NutrientViewer.Geometry.Point | null;
            },
        >
    )[],
): this
Parameters
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
    >
)[]
Returns
this
Inherited from InheritableImmutableRecord.mergeDeep

mergeDeepIn

mergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                cap: | "square"
                | "circle"
                | "diamond"
                | "openArrow"
                | "closedArrow"
                | "butt"
                | "reverseOpenArrow"
                | "reverseClosedArrow"
                | "slash"
                | null;
                end: NutrientViewer.Geometry.Point
                | null;
                innerRectInset: NutrientViewer.Geometry.Inset | null;
                knee: NutrientViewer.Geometry.Point | null;
                start: NutrientViewer.Geometry.Point | null;
            },
        >
    )[],
): this
Parameters
keyPathIterable<unknown>
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
    >
)[]
Returns
this
Inherited from InheritableImmutableRecord.mergeDeepIn

mergeDeepWith

mergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                cap: | "square"
                | "circle"
                | "diamond"
                | "openArrow"
                | "closedArrow"
                | "butt"
                | "reverseOpenArrow"
                | "reverseClosedArrow"
                | "slash"
                | null;
                end: NutrientViewer.Geometry.Point
                | null;
                innerRectInset: NutrientViewer.Geometry.Inset | null;
                knee: NutrientViewer.Geometry.Point | null;
                start: NutrientViewer.Geometry.Point | null;
            },
        >
    )[],
): this
Parameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
    >
)[]
Returns
this
Inherited from InheritableImmutableRecord.mergeDeepWith

mergeIn

mergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeIn(
    keyPath: Iterable<unknown>,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                cap: | "square"
                | "circle"
                | "diamond"
                | "openArrow"
                | "closedArrow"
                | "butt"
                | "reverseOpenArrow"
                | "reverseClosedArrow"
                | "slash"
                | null;
                end: NutrientViewer.Geometry.Point
                | null;
                innerRectInset: NutrientViewer.Geometry.Inset | null;
                knee: NutrientViewer.Geometry.Point | null;
                start: NutrientViewer.Geometry.Point | null;
            },
        >
    )[],
): this
Parameters
keyPathIterable<unknown>
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
    >
)[]
Returns
this
Inherited from InheritableImmutableRecord.mergeIn

mergeWith

mergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
    merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
    ...collections: (
        | Iterable<[string, unknown], any, any>
        | Partial<
            {
                cap: | "square"
                | "circle"
                | "diamond"
                | "openArrow"
                | "closedArrow"
                | "butt"
                | "reverseOpenArrow"
                | "reverseClosedArrow"
                | "slash"
                | null;
                end: NutrientViewer.Geometry.Point
                | null;
                innerRectInset: NutrientViewer.Geometry.Inset | null;
                knee: NutrientViewer.Geometry.Point | null;
                start: NutrientViewer.Geometry.Point | null;
            },
        >
    )[],
): this
Parameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown
...collections
(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
    | Iterable<[string, unknown], any, any>
    | Partial<
        {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
    >
)[]
Returns
this
Inherited from InheritableImmutableRecord.mergeWith

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from InheritableImmutableRecord.removeIn

set

set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
    K extends
        keyof {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
>(
    key: K,
    value: {
        cap:
            | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
        end: NutrientViewer.Geometry.Point
        | null;
        innerRectInset: NutrientViewer.Geometry.Inset | null;
        knee: NutrientViewer.Geometry.Point | null;
        start: NutrientViewer.Geometry.Point | null;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}
Parameters
keyK
value
{ … }[K]{
    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}[K]
Returns
this
Inherited from InheritableImmutableRecord.set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from InheritableImmutableRecord.setIn

toJS

toJS(): { … }toJS(): {
    cap: | "square"
    | "circle"
    | "diamond"
    | "openArrow"
    | "closedArrow"
    | "butt"
    | "reverseOpenArrow"
    | "reverseClosedArrow"
    | "slash"
    | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}
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
{ … }{
    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}
Inherited from InheritableImmutableRecord.toJS

toJSON

toJSON(): { … }toJSON(): {
    cap: | "square"
    | "circle"
    | "diamond"
    | "openArrow"
    | "closedArrow"
    | "butt"
    | "reverseOpenArrow"
    | "reverseClosedArrow"
    | "slash"
    | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns
{ … }{
    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}
Inherited from InheritableImmutableRecord.toJSON

toSeq

toSeq(): Keyed<string, unknown>
Returns
Keyed<string, unknown>
Inherited from InheritableImmutableRecord.toSeq

update

update<K extends keyof { … }>(
    key: K,
    updater: (value: { … }[K]) => { … }[K],
): thisupdate<
    K extends
        keyof {
            cap: | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
>(
    key: K,
    updater: (
        value: {
            cap:
                | "square"
                | "circle"
                | "diamond"
                | "openArrow"
                | "closedArrow"
                | "butt"
                | "reverseOpenArrow"
                | "reverseClosedArrow"
                | "slash"
                | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        }[K],
    ) => {
        cap: | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
        end: NutrientViewer.Geometry.Point
        | null;
        innerRectInset: NutrientViewer.Geometry.Inset | null;
        knee: NutrientViewer.Geometry.Point | null;
        start: NutrientViewer.Geometry.Point | null;
    }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
    cap:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
    value: {
        cap:
            | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
        end: NutrientViewer.Geometry.Point
        | null;
        innerRectInset: NutrientViewer.Geometry.Inset | null;
        knee: NutrientViewer.Geometry.Point | null;
        start: NutrientViewer.Geometry.Point | null;
    }[K],
) => {
    cap: | "square"
    | "circle"
    | "diamond"
    | "openArrow"
    | "closedArrow"
    | "butt"
    | "reverseOpenArrow"
    | "reverseClosedArrow"
    | "slash"
    | null;
    end: NutrientViewer.Geometry.Point
    | null;
    innerRectInset: NutrientViewer.Geometry.Inset | null;
    knee: NutrientViewer.Geometry.Point | null;
    start: NutrientViewer.Geometry.Point | null;
}[K]
Returns
this
Inherited from InheritableImmutableRecord.update

updateIn

updateIn(
    keyPath: Iterable<unknown>,
    notSetValue: unknown,
    updater: (value: unknown) => unknown,
): this
Parameters
keyPathIterable<unknown>
notSetValueunknown
updater(value: unknown) => unknown
Returns
this
Inherited from InheritableImmutableRecord.updateIn
updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from InheritableImmutableRecord.updateIn

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 InheritableImmutableRecord.withMutations

Class Callout

Hierarchy

Constructors

Parameters

Properties

Immutable Record API

Returns

See Also

Returns

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See Also