Aggregate

public struct Aggregate : Transform

Specification of aggregate operation on trace data.

See also

Documentation for Python, JavaScript or R

  • Determines whether this aggregate transform is enabled or disabled.

    Declaration

    Swift

    public var enabled: Bool?

  • Sets the grouping target to which the aggregation is applied.

    Data points with matching group values will be coalesced into one point, using the supplied aggregation functions to reduce data in other data arrays. If a string, groups is assumed to be a reference to a data array in the parent trace object. To aggregate by nested variables, use . to access them. For example, set groups to marker.color to aggregate about the marker color array. If an array, groups is itself the data array by which we aggregate.

    Declaration

    Swift

    public var groups: Data<String>?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Aggregation : Encodable

  • Undocumented

    Declaration

    Swift

    public var aggregations: [Aggregation]?

  • Creates Aggregate object with specified properties.

    Declaration

    Swift

    public init(enabled: Bool? = nil, groups: Data<String>? = nil, aggregations: [Aggregation]? =
        nil)

    Parameters

    enabled

    Determines whether this aggregate transform is enabled or disabled.
    groups

    Sets the grouping target to which the aggregation is applied.
    aggregations