smile.plot.vega.ViewComposition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smile-plot Show documentation
smile-plot
There is a newer version: 4.0.0
/*
 * Copyright (c) 2010-2021 Haifeng Li. All rights reserved.
 *
 * Smile is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Smile is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Smile.  If not, see .
 */
package smile.plot.vega;

import com.fasterxml.jackson.databind.node.ObjectNode;

/**
 * All view composition specifications (layer, facet, concat, and repeat)
 * can have the resolve property for scale, axes, and legend resolution.
 * 
 * Vega-Lite determines whether scale domains should be unioned.
 * If the scale domain is unioned, axes and legends can be merged.
 * Otherwise, they have to be independent.
 * 
 * There are two options to resolve a scale, axis, or legend: "shared"
 * and "independent". Independent scales imply independent axes and legends.
 *
 * @author Haifeng Li
 */
public interface ViewComposition {
    /**
     * Returns the top level Vega-Lite specification.
     */
    ObjectNode spec();

    /**
     * Sets a scale resolution. For scales, resolution can be specified for every channel.
     * @param channel positional or non-positional channel.
     * @param resolution "shared" or "independent".
     * @return this object.
     */
    default ViewComposition resolveScale(String channel, String resolution) {
        ObjectNode spec = spec();
        ObjectNode resolve = spec.has("resolve") ? (ObjectNode) spec.get("resolve"): spec.putObject("resolve");
        ObjectNode scale = resolve.has("scale") ? (ObjectNode) resolve.get("scale"): resolve.putObject("scale");
        scale.put(channel, resolution);
        return this;
    }

    /**
     * Sets an axis resolution.
     * @param channel positional channel: "x" or "y".
     * @param resolution "shared" or "independent".
     * @return this object.
     */
    default ViewComposition resolveAxis(String channel, String resolution) {
        ObjectNode spec = spec();
        ObjectNode resolve = spec.has("resolve") ? (ObjectNode) spec.get("resolve"): spec.putObject("resolve");
        ObjectNode axis = resolve.has("axis") ? (ObjectNode) resolve.get("axis"): resolve.putObject("axis");
        axis.put(channel, resolution);
        return this;
    }

    /**
     * Sets a legend resolution.
     * @param channel non-positional channel: "color", "opacity", "shape", or "size".
     * @param resolution "shared" or "independent".
     * @return this object.
     */
    default ViewComposition resolveLegend(String channel, String resolution) {
        ObjectNode spec = spec();
        ObjectNode resolve = spec.has("resolve") ? (ObjectNode) spec.get("resolve"): spec.putObject("resolve");
        ObjectNode legend = resolve.has("legend") ? (ObjectNode) resolve.get("legend"): resolve.putObject("legend");
        legend.put(channel, resolution);
        return this;
    }
}