LineCallout3D

AMD: require(["esri/symbols/callouts/LineCallout3D"], (LineCallout3D) => { /* code goes here */ });
ESM: import LineCallout3D from "@arcgis/core/symbols/callouts/LineCallout3D";
Class: esri/symbols/callouts/LineCallout3D
Inheritance: LineCallout3D Callout3D Accessor
Since: ArcGIS API for JavaScript 4.4

This type of callout displays a line to connect a symbol or a label with its actual location in the scene. For example when displaying points of interest in a city, visualizing them with a callout line helps to understand where the points are actually located:

symbol3D-line-callout

This visualization can be created on a PointSymbol3D or a LabelSymbol3D. After defining the symbolLayers, an offset should be defined by setting the verticalOffset property. The symbols are now shifted vertically, but we still need to add the callout, otherwise it can be very confusing to understand where the points are located:

symbol3D-line-callout

Setting the callout property of type line on the symbol will create the line that connects the symbol with its actual position:

symbol3D-line-callout

See also:
Example:
let symbol = {
  type: "point-3d",  // autocasts as new PointSymbol3D()
  symbolLayers: [{
    type: "icon",  // autocasts as new IconSymbol3DLayer()
    resource: {
      href: "CityHall.svg"
    },
    size: 20
  }],
  verticalOffset: {
    screenLength: 40,
    maxWorldLength: 100,
    minWorldLength: 20
  },
  callout: {
    type: "line", // autocasts as new LineCallout3D()
    size: 1.5,
    color: "white",
    border: {
      color: "black"
    }
  }
});

Constructors

new LineCallout3D(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Accessormore details

The border settings of the callout line.

more detailsLineCallout3D
Colormore details

The color of the callout line.

more detailsLineCallout3D
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

The width of the callout line in points.

more detailsLineCallout3D
Stringmore details For LineCallout3D the type is always "line". more detailsLineCallout3D

Property Details

The border settings of the callout line. The border of the callout line can be used to improve the contrast of the callout line color against various background colors. If the border is null, then no border will be visible.

Property:
color Color
optional
Default Value:white
Autocasts from Object|Number[]|String

The color of the callout line border. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with r, g, b, and a properties, or a Color object.

Autocasts from Object|Number[]|String

The color of the callout line. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with r, g, b, and a properties, or a Color object.

Default Value:black
declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

Autocasts from Number|String

The width of the callout line in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value:1px
type String

For LineCallout3D the type is always "line".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
LineCallout3Dmore details

Creates a deep clone of the callout.

more detailsLineCallout3D
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsCallout3D
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsCallout3D

Method Details

clone(){LineCallout3D}

Creates a deep clone of the callout.

Returns:
Type Description
LineCallout3D A deep clone of the object that invoked this method.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.