Class/Object

org.querki.jsext

JSOptionBuilder

Related Docs: object JSOptionBuilder | package jsext

Permalink

abstract class JSOptionBuilder[T <: Object, B <: JSOptionBuilder[T, _]] extends JSOptionSetter[T, B]

Helper class for defining strongly-typed "options" classes to pass into Scala.js facades. This approach is particularly helpful for jQuery-based facades, which often take very complex options objects, with large numbers of polymorphic fields.

T

A placeholder facade trait -- usually just a declaration of a trait that inherits from js.Object.

B

This class. (It is probably possible to eliminate this declaration, but I haven't figured it out yet.)

Linear Supertypes
JSOptionSetter[T, B], AnyRef, Any
Known Subclasses
AppearanceOptions, AppearanceOptionsBuilder, ArcGisImageServerTerrainProviderOptions, ArcGisImageServerTerrainProviderOptionsBuilder, ArcGisMapServerImageryProviderOptions, ArcGisMapServerImageryProviderOptionsBuilder, BaseLayerPickerOptions, BaseLayerPickerOptionsBuilder, BaseLayerPickerViewModelOptions, BaseLayerPickerViewModelOptionsBuilder, BillboardCollectionOptions, BillboardCollectionOptionsBuilder, BillboardGraphicsOptions, BillboardGraphicsOptionsBuilder, BingMapsImageryProviderOptions, BingMapsImageryProviderOptionsBuilder, BoxGeometryOptions, BoxGeometryOptionsBuilder, BoxGraphicsOptions, BoxGraphicsOptionsBuilder, BoxOutlineGeometryOptions, BoxOutlineGeometryOptionsBuilder, CameraFlyToBoundingSphereOptions, CameraFlyToBoundingSphereOptionsBuilder, CameraFlyToOptions, CameraFlyToOptionsBuilder, CameraSetViewOptions, CameraSetViewOptionsBuilder, CatmullRomSplineOptions, CatmullRomSplineOptionsBuilder, CesiumTerrainProviderOptions, CesiumTerrainProviderOptionsBuilder, CesiumWidgetOptions, CesiumWidgetOptionsBuilder, CheckerboardMaterialPropertyOptions, CheckerboardMaterialPropertyOptionsBuilder, CircleGeometryOptions, CircleGeometryOptionsBuilder, CircleOutlineGeometryOptions, CircleOutlineGeometryOptionsBuilder, ClockOptions, ClockOptionsBuilder, ConstantHeightsOptions, ConstantHeightsOptionsBuilder, CorridorGeometryOptions, CorridorGeometryOptionsBuilder, CorridorGraphicsOptions, CorridorGraphicsOptionsBuilder, CorridorOutlineGeometryOptions, CorridorOutlineGeometryOptionsBuilder, CylinderGeometryOptions, CylinderGeometryOptionsBuilder, CylinderGraphicsOptions, CylinderGraphicsOptionsBuilder, CylinderOutlineGeometryOptions, CylinderOutlineGeometryOptionsBuilder, CzmlDataSourceOptions, CzmlDataSourceOptionsBuilder, DataSourceDisplayOptions, DataSourceDisplayOptionsBuilder, DebugAppearanceOptions, DebugAppearanceOptionsBuilder, DebugCameraPrimitiveOptions, DebugCameraPrimitiveOptionsBuilder, DebugModelMatrixPrimitiveOptions, DebugModelMatrixPrimitiveOptionsBuilder, DimensionsOptions, DimensionsOptionsBuilder, DiscardMissingTileImagePolicyOptions, DiscardMissingTileImagePolicyOptionsBuilder, DragDropMixinOptions, DragDropMixinOptionsBuilder, EllipseGeometryOptions, EllipseGeometryOptionsBuilder, EllipseGraphicsOptions, EllipseGraphicsOptionsBuilder, EllipseOutlineGeometryOptions, EllipseOutlineGeometryOptionsBuilder, EllipsoidGeometryOptions, EllipsoidGeometryOptionsBuilder, EllipsoidGraphicsOptions, EllipsoidGraphicsOptionsBuilder, EllipsoidOutlineGeometryOptions, EllipsoidOutlineGeometryOptionsBuilder, EllipsoidSurfaceAppearanceOptions, EllipsoidSurfaceAppearanceOptionsBuilder, EllipsoidTerrainProviderOptions, EllipsoidTerrainProviderOptionsBuilder, EntityClusterOptions, EntityClusterOptionsBuilder, EntityOptions, EntityOptionsBuilder, FindIntervalOptions, FindIntervalOptionsBuilder, FrameRateMonitorOptions, FrameRateMonitorOptionsBuilder, GeoJsonDataSourceOptions, GeoJsonDataSourceOptionsBuilder, GeocoderOptions, GeocoderOptionsBuilder, GeocoderViewModelOptions, GeocoderViewModelOptionsBuilder, GeographicTilingSchemeOptions, GeographicTilingSchemeOptionsBuilder, GeometryAttributeOptions, GeometryAttributeOptionsBuilder, GeometryInstanceAttributeOptions, GeometryInstanceAttributeOptionsBuilder, GeometryInstanceOptions, GeometryInstanceOptionsBuilder, GeometryOptions, GeometryOptionsBuilder, GoogleEarthImageryProviderOptions, GoogleEarthImageryProviderOptionsBuilder, GridImageryProviderOptions, GridImageryProviderOptionsBuilder, GridMaterialPropertyOptions, GridMaterialPropertyOptionsBuilder, GroundPrimitiveOptions, GroundPrimitiveOptionsBuilder, HeightmapTerrainDataOptions, HeightmapTerrainDataOptionsBuilder, HeightmapTerrainDataStructureOptions, HeightmapTerrainDataStructureOptionsBuilder, HermiteSplineOptions, HermiteSplineOptionsBuilder, ImageMaterialPropertyOptions, ImageMaterialPropertyOptionsBuilder, ImageryLayerOptions, ImageryLayerOptionsBuilder, InterpolationOptions, InterpolationOptionsBuilder, Iso8601Options, Iso8601OptionsBuilder, JsonpOptions, JsonpOptionsBuilder, KmlDataSourceOptions, KmlDataSourceOptionsBuilder, LabelCollectionOptions, LabelCollectionOptionsBuilder, LabelGraphicsOptions, LabelGraphicsOptionsBuilder, LabelOptions, LabelOptionsBuilder, LinearSplineOptions, LinearSplineOptionsBuilder, MapboxImageryProviderOptions, MapboxImageryProviderOptionsBuilder, MaterialAppearanceOptions, MaterialAppearanceOptionsBuilder, MaterialOptions, MaterialOptionsBuilder, ModelAnimationCollectionAddAllOptions, ModelAnimationCollectionAddAllOptionsBuilder, ModelAnimationCollectionAddOptions, ModelAnimationCollectionAddOptionsBuilder, ModelFromGltfOptions, ModelFromGltfOptionsBuilder, ModelGraphicsOptions, ModelGraphicsOptionsBuilder, ModelOptions, ModelOptionsBuilder, MoonOptions, MoonOptionsBuilder, NavigationHelpButtonOptions, NavigationHelpButtonOptionsBuilder, NodeTransformationPropertyOptions, NodeTransformationPropertyOptionsBuilder, OpenStreetMapImageryProviderOptions, OpenStreetMapImageryProviderOptionsBuilder, PathGraphicsOptions, PathGraphicsOptionsBuilder, PerInstanceColorAppearanceOptions, PerInstanceColorAppearanceOptionsBuilder, PerformanceWatchdogOptions, PerformanceWatchdogOptionsBuilder, PerformanceWatchdogViewModelOptions, PerformanceWatchdogViewModelOptionsBuilder, PointGraphicsOptions, PointGraphicsOptionsBuilder, PointPrimitiveCollectionOptions, PointPrimitiveCollectionOptionsBuilder, PolygonGeometryOptions, PolygonGeometryOptionsBuilder, PolygonGraphicsOptions, PolygonGraphicsOptionsBuilder, PolygonOutlineGeometryOptions, PolygonOutlineGeometryOptionsBuilder, PolylineCollectionOptions, PolylineCollectionOptionsBuilder, PolylineColorAppearanceOptions, PolylineColorAppearanceOptionsBuilder, PolylineGeometryOptions, PolylineGeometryOptionsBuilder, PolylineGlowMaterialPropertyOptions, PolylineGlowMaterialPropertyOptionsBuilder, PolylineGraphicsOptions, PolylineGraphicsOptionsBuilder, PolylineMaterialAppearanceOptions, PolylineMaterialAppearanceOptionsBuilder, PolylineOptions, PolylineOptionsBuilder, PolylineOutlineMaterialPropertyOptions, PolylineOutlineMaterialPropertyOptionsBuilder, PolylineVolumeGeometryOptions, PolylineVolumeGeometryOptionsBuilder, PolylineVolumeGraphicsOptions, PolylineVolumeGraphicsOptionsBuilder, PolylineVolumeOutlineGeometryOptions, PolylineVolumeOutlineGeometryOptionsBuilder, PositionsOptions, PositionsOptionsBuilder, PrimitiveCollectionOptions, PrimitiveCollectionOptionsBuilder, PrimitiveOptions, PrimitiveOptionsBuilder, ProviderViewModelOptions, ProviderViewModelOptionsBuilder, QuantizedMeshTerrainDataOptions, QuantizedMeshTerrainDataOptionsBuilder, QuaternionSplineOptions, QuaternionSplineOptionsBuilder, RandomColorOptions, RandomColorOptionsBuilder, RectangleGeometryOptions, RectangleGeometryOptionsBuilder, RectangleGraphicsOptions, RectangleGraphicsOptionsBuilder, RectangleOutlineGeometryOptions, RectangleOutlineGeometryOptionsBuilder, SceneOptions, SceneOptionsBuilder, ShadowMapOptions, ShadowMapOptionsBuilder, SimplePolylineGeometryOptions, SimplePolylineGeometryOptionsBuilder, SingleTileImageryProviderOptions, SingleTileImageryProviderOptionsBuilder, SkyBoxOptions, SkyBoxOptionsBuilder, SphereGeometryOptions, SphereGeometryOptionsBuilder, SphereOutlineGeometryOptions, SphereOutlineGeometryOptionsBuilder, StripeMaterialPropertyOptions, StripeMaterialPropertyOptionsBuilder, TangentSpaceDebugPrimitiveOptions, TangentSpaceDebugPrimitiveOptionsBuilder, TileCoordinatesImageryProviderOptions, TileCoordinatesImageryProviderOptionsBuilder, TileMapServiceImageryProviderOptions, TileMapServiceImageryProviderOptionsBuilder, TimeIntervalOptions, TimeIntervalOptionsBuilder, ToggleButtonViewModelOptions, ToggleButtonViewModelOptionsBuilder, UrlTemplateImageryProviderOptions, UrlTemplateImageryProviderOptionsBuilder, VRTheWorldTerrainProviderOptions, VRTheWorldTerrainProviderOptionsBuilder, VertexFormatOptions, VertexFormatOptionsBuilder, VideoSynchronizerOptions, VideoSynchronizerOptionsBuilder, ViewerFlyToOptions, ViewerFlyToOptionsBuilder, ViewerOptions, ViewerOptionsBuilder, WallGeometryOptions, WallGeometryOptionsBuilder, WallGraphicsOptions, WallGraphicsOptionsBuilder, WallOutlineGeometryOptions, WallOutlineGeometryOptionsBuilder, WebMapServiceImageryProviderOptions, WebMapServiceImageryProviderOptionsBuilder, WebMapTileServiceImageryProviderOptions, WebMapTileServiceImageryProviderOptionsBuilder, WebMercatorTilingSchemeOptions, WebMercatorTilingSchemeOptionsBuilder, WithXhrOptions, WithXhrOptionsBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JSOptionBuilder
  2. JSOptionSetter
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JSOptionBuilder(copy: (OptMap) ⇒ B)

    Permalink

    copy

    The chaining constructor. You don't usually need to worry about this explicitly, just follow the documented patterns.

Abstract Value Members

  1. abstract def dict: OptMap

    Permalink

    This is a dictionary of option values.

    This is a dictionary of option values. It is usually *very* heterogeneous, mixing everything from Ints to Functions. So it needs to be js.Any.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def _result: T

    Permalink

    Extract the built-up options, in a form suitable for passing into a typical facade.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. def jsOpt(name: String, opt: Any): B

    Permalink

    Define one field in an options class.

    Define one field in an options class.

    Note that jsOpt is not, in and of itself, strongly-typed. You use this helper to add a strongly-typed method for each field.

    Attributes
    protected
    Definition Classes
    JSOptionBuilder → JSOptionSetter

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    JSOptionBuilder → AnyRef → Any

  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from JSOptionSetter[T, B]

Inherited from AnyRef

Inherited from Any

Ungrouped