Class Callout

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

Hierarchy

InheritableImmutableRecord<
    {
        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;
    },
>
- Callout

Index

Constructors

constructor

new Callout(
    values?:
        | 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;
            },
        >,
): Callout
Parameters
- Optionalvalues:
      | 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 Callout
Inherited from InheritableImmutableRecord<ICallout>.constructor

Properties

cap

The line cap style.

end

end: NutrientViewer.Geometry.Point | null

Ending point of the arrow line.

innerRectInset

innerRectInset: NutrientViewer.Geometry.Inset | null

The inner rectangle inset.

knee

knee: NutrientViewer.Geometry.Point | null

Knee point of the arrow line.

start

start: NutrientViewer.Geometry.Point | null

Starting point of the arrow line.

`Static`defaultValues

defaultValues: {
    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;
} = ...

Methods

asImmutable

asImmutable(): this
Returns this
Inherited from InheritableImmutableRecord.asImmutable

asMutable

asMutable(): this
Returns this
Inherited from InheritableImmutableRecord.asMutable

clear

clear(): this
Returns this
Inherited from InheritableImmutableRecord.clear

delete

delete<
    K extends
        keyof {
            cap: ILineCap | null;
            end: NutrientViewer.Geometry.Point
            | null;
            innerRectInset: NutrientViewer.Geometry.Inset | null;
            knee: NutrientViewer.Geometry.Point | null;
            start: NutrientViewer.Geometry.Point | null;
        },
>(
    key: K,
): this
Type Parameters
- K extends keyof {
      cap: ILineCap | null;
      end: NutrientViewer.Geometry.Point | null;
      innerRectInset: NutrientViewer.Geometry.Inset | null;
      knee: NutrientViewer.Geometry.Point | null;
      start: NutrientViewer.Geometry.Point | null;
  }
Parameters
- key: K
Returns this
Inherited from InheritableImmutableRecord.delete

deleteIn

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

equals

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

get

get<
    K extends
        keyof {
            cap: ILineCap | 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]
Type Parameters
- K extends keyof {
      cap: ILineCap | null;
      end: NutrientViewer.Geometry.Point | null;
      innerRectInset: NutrientViewer.Geometry.Inset | null;
      knee: NutrientViewer.Geometry.Point | null;
      start: NutrientViewer.Geometry.Point | null;
  }
Parameters
- key: K
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;
}[K]
Inherited from InheritableImmutableRecord.get

getIn

getIn(keyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Parameters
- keyPath: Iterable<unknown>
- OptionalnotSetValue: unknown
Returns unknown
Inherited from InheritableImmutableRecord.getIn

has

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

merge

merge(
    ...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<
      {
          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<
            {
                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<
          {
              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<
            {
                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
- 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;
          },
      >
  )[]
Returns this
Inherited from InheritableImmutableRecord.mergeDeepIn

mergeDeepWith

mergeDeepWith(
    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<
          {
              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<
            {
                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
- 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;
          },
      >
  )[]
Returns this
Inherited from InheritableImmutableRecord.mergeIn

mergeWith

mergeWith(
    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<
          {
              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
- keyPath: Iterable<unknown>
Returns this
Inherited from InheritableImmutableRecord.removeIn

set

set<
    K extends
        keyof {
            cap: ILineCap | 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 {
      cap: ILineCap | null;
      end: NutrientViewer.Geometry.Point | null;
      innerRectInset: NutrientViewer.Geometry.Inset | null;
      knee: NutrientViewer.Geometry.Point | null;
      start: NutrientViewer.Geometry.Point | null;
  }
Parameters
- 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]
Returns this
Inherited from InheritableImmutableRecord.set

setIn

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

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;
}
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(): {
    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 {
    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 {
            cap: ILineCap | 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 {
      cap: ILineCap | null;
      end: NutrientViewer.Geometry.Point | null;
      innerRectInset: NutrientViewer.Geometry.Inset | null;
      knee: NutrientViewer.Geometry.Point | null;
      start: NutrientViewer.Geometry.Point | null;
  }
Parameters
- 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]
Returns this
Inherited from InheritableImmutableRecord.update

updateIn

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

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Parameters
- mutator: (mutable: this) => unknown
Returns this
Inherited from InheritableImmutableRecord.withMutations

Class Callout

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Callout

Properties

cap

end

innerRectInset

knee

start

StaticdefaultValues

Methods

asImmutable

Returns this

asMutable

Returns this

clear

Returns this

delete

Type Parameters

Parameters

Returns this

deleteIn

Parameters

Returns this

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

getIn

Parameters

Returns unknown

has

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

Returns this

mergeWith

Parameters

Returns this

removeIn

Parameters

Returns this

set

Type Parameters

Parameters

Returns this

setIn

Parameters

Returns this

toJS

toJSON

toSeq

Returns Keyed<string, unknown>

update

Type Parameters

Parameters

Returns this

updateIn

`Static`defaultValues