org.cesiumjs.cs.core.options

Class RequestOptions

java.lang.Object

org.cesiumjs.cs.core.options.RequestOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class RequestOptions
extends Object

Options for Request

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Request.CancelCallback	cancelFunction The function that is called when the request is cancelled.
double	priority The initial priority of the request.
Request.PriorityCallback	priorityFunction The function that is called to update the request's priority, which occurs once per frame.
Request.RequestCallback	requestFunction The function that makes the actual data request.
boolean	throttle Whether to throttle and prioritize the request.
boolean	throttleByServer Whether to throttle the request by server.
Number	type The type of request.
boolean	url The url to request.

Constructor Summary

Constructors

Constructor and Description
RequestOptions()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

url

@JsProperty
public boolean url

The url to request.

requestFunction

@JsProperty
public Request.RequestCallback requestFunction

The function that makes the actual data request.

cancelFunction

@JsProperty
public Request.CancelCallback cancelFunction

The function that is called when the request is cancelled.

priorityFunction

@JsProperty
public Request.PriorityCallback priorityFunction

The function that is called to update the request's priority, which occurs once per frame.

priority

@JsProperty
public double priority

The initial priority of the request. Default: 0.0

throttle

@JsProperty
public boolean throttle

Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the request will be throttled and sent based on priority. Default: false

throttleByServer

@JsProperty
public boolean throttleByServer

Whether to throttle the request by server. Default: false

type

@JsProperty
public Number type

The type of request.

See Also:

Default: {@link org.cesiumjs.cs.core.enums.RequestType#OTHER()}

Constructor Detail

RequestOptions

@JsConstructor
public RequestOptions()