altair.Point#
- class altair.Point(coordinates=Undefined, type=Undefined, bbox=Undefined, **kwds)#
Point schema wrapper.
Point geometry object. https://tools.ietf.org/html/rfc7946#section-3.1.2
- Parameters:
- coordinatesSequence[float],
Position A Position is an array of coordinates. https://tools.ietf.org/html/rfc7946#section-3.1.1 Array should contain between two and three elements. The previous GeoJSON specification allowed more elements (e.g., which could be used to represent M values), but the current specification only allows X, Y, and (optionally) Z to be defined.
Note: the type will not be narrowed down to
[number, number] | [number, number, number]due to marginal benefits and the large impact of breaking change.See previous discussions on the type narrowing:
{@link DefinitelyTyped/DefinitelyTyped#21590 Nov 2017 }
{@link DefinitelyTyped/DefinitelyTyped#67773 Dec 2023 }
{@link DefinitelyTyped/DefinitelyTyped#71441 Dec 2024 }
One can use a {@link https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates user-defined type guard that returns a type predicate } to determine if a position is a 2D or 3D position.
- typeLiteral[‘Point’]
Specifies the type of GeoJSON object.
- bbox
BBox, Sequence[float] Bounding box of the coordinate range of the object’s Geometries, Features, or Feature Collections. The value of the bbox member is an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. https://tools.ietf.org/html/rfc7946#section-5
- coordinatesSequence[float],
- __init__(coordinates=Undefined, type=Undefined, bbox=Undefined, **kwds)#
Methods
__init__([coordinates, type, bbox])copy([deep, ignore])Return a copy of the object.
from_dict(dct[, validate])Construct class from a dictionary representation.
from_json(json_string[, validate])Instantiate the object from a valid JSON string.
resolve_references([schema])Resolve references in the context of this object's schema or root schema.
to_dict([validate, ignore, context])Return a dictionary representation of the object.
to_json([validate, indent, sort_keys, ...])Emit the JSON representation for this object as a string.
validate(instance[, schema])Validate the instance against the class schema in the context of the rootschema.
validate_property(name, value[, schema])Validate a property against property schema in the context of the rootschema.