altair.EncodingSortField

class altair.EncodingSortField(field=Undefined, op=Undefined, order=Undefined, **kwds)

EncodingSortField schema wrapper.

A sort definition for sorting a discrete scale in an encoding field definition.

Parameters:

fieldstr, dict, Field, FieldName, RepeatRef

The data field to sort by.

Default value: If unspecified, defaults to the field specified in the outer data reference.

opNonArgAggregateOp, Literal[‘average’, ‘count’, ‘distinct’, ‘max’, ‘mean’, ‘median’, ‘min’, ‘missing’, ‘product’, ‘q1’, ‘q3’, ‘ci0’, ‘ci1’, ‘stderr’, ‘stdev’, ‘stdevp’, ‘sum’, ‘valid’, ‘values’, ‘variance’, ‘variancep’, ‘exponential’, ‘exponentialb’]

An aggregate operation to perform on the field prior to sorting (e.g., "count", "mean" and "median"). An aggregation is required when there are multiple values of the sort field for each encoded data field. The input data objects will be aggregated, grouped by the encoded data field.

For a full list of operations, please see the documentation for aggregate.

Default value: "sum" for stacked plots. Otherwise, "min".

orderSortOrder, Literal[‘ascending’, ‘descending’], None

The sort order. One of "ascending" (default), "descending", or null (no not sort).

__init__(field=Undefined, op=Undefined, order=Undefined, **kwds)

Methods

__init__([field, op, order])
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.