org.fujion.plotly.plot.StreamOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fujion-plotly Show documentation

The newest version!

/*
 * #%L
 * fujion
 * %%
 * Copyright (C) 2021 Fujion Framework
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * #L%
 */
package org.fujion.plotly.plot;

import org.fujion.ancillary.Options;
import org.fujion.annotation.Option;

public class StreamOptions extends Options {
    
    /**
     * The maximum number of points to keep on the plots from an incoming stream. If "maxpoints" is
     * set to 50, only the newest 50 points will be displayed on the plot.
     * 
     * Default: 500
     */
    @Option
    public Integer maxpoints;
    
    /**
     * The stream id number links a data trace on a plot with a stream. See
     * plotly documentation for more details.
     */
    @Option
    public String token;
}