Class default

A common interface for Export sub fixtures.

Export

ExportSubFixture

Hierarchy

FixtureInstance
- default

Implements

ExportSubFixture

Index

Constructors

constructor

new default(id, iApi): default
Creates an instance of FixtureInstance.

Memberof
FixtureInstance
Parameters
- id: string
- iApi: InstanceAPI
Returns default
Inherited from FixtureInstance.constructor
- Defined in src/api/fixture.ts:291

Properties

`Readonly` $iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

`Readonly` id

id: string

ID of this fixture.

Memberof

FixtureInstance

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Implementation of ExportSubFixture.$element

Inherited from FixtureInstance.$element
- Defined in src/api/common.ts:31

$vApp

get $vApp(): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>
The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

Memberof
APIScope

Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>
Implementation of ExportSubFixture.$vApp

Inherited from FixtureInstance.$vApp
- Defined in src/api/common.ts:27

config

get config(): any
Returns the fixture config section (JSON) taken from the global config.

Memberof
FixtureInstance

Returns any
Implementation of ExportSubFixture.config

Overrides FixtureInstance.config
- Defined in src/fixtures/export-legend/index.ts:51

Methods

`Private` _getLayerTreeIds

_getLayerTreeIds(rootLayer): number[]
Private
Gets flattened array of ids from layer tree

Memberof
ExportLegendFixture
Parameters
- rootLayer: LayerInstance
Returns number[]
- Defined in src/fixtures/export-legend/index.ts:362

`Private` _makeChunkItems

_makeChunkItems(symbologyStack, segmentWidth): Promise<Group>[]
Private
Creates layer entry symbology based on the provided symbology stack.

Memberof
ExportLegendFixture
Parameters
- symbologyStack: LegendSymbology[]
- segmentWidth: number
Returns Promise<Group>[]
- Defined in src/fixtures/export-legend/index.ts:298

`Private` _makeColumns

_makeColumns(items, columnWidth, columns): Group
Private
Breaks up legend layers into columns

Memberof
ExportLegendFixture
Parameters
- items: Group[]
- columnWidth: number
- columns: number
Returns Group
- Defined in src/fixtures/export-legend/index.ts:152

`Private` _makeSegmentChunks

_makeSegmentChunks(ids, layer, segmentWidth): Promise<SegmentChunk>[]
Private
Creates segment chunks based on the provided layer and layer entry id.

Used for layers that support sublayers (e.g. MapImageLayers)

Memberof
ExportLegendFixture
Parameters
- ids: number[]
- layer: LayerInstance
- segmentWidth: number
Returns Promise<SegmentChunk>[]
- Defined in src/fixtures/export-legend/index.ts:248

`Private` _makeSegments

_makeSegments(layers, segmentWidth): Promise<Segment>[]
Private
Create segments of the export image based on the provided layers and layer configs.

Memberof
ExportLegendFixture
Parameters
- layers: LayerInstance[]
- segmentWidth: number
Returns Promise<Segment>[]
- Defined in src/fixtures/export-legend/index.ts:210

`Optional` added

added(): void
Returns void
Implementation of ExportSubFixture.added

Inherited from FixtureInstance.added
- Defined in src/api/fixture.ts:371

extend

extend(vueComponent, options?): any
A helper function to create a "subclass" of the base Vue constructor

Memberof
FixtureInstance
Parameters
- vueComponent: Record<string, any>
- Optional options: ComponentOptions<{}, any, any, any, any, any, any, any, any> = {}
Returns any
Implementation of ExportSubFixture.extend

Inherited from FixtureInstance.extend
- Defined in src/api/fixture.ts:317

getLayerFixtureConfig

getLayerFixtureConfig(layerId): any
Get this fixture's config from the layer config with the given layer id Will return undefined if layer config did not specify a config for this fixture
Parameters
- layerId: string
  
  The layer's id
Returns any
This fixture's config for the given layer
Implementation of ExportSubFixture.getLayerFixtureConfig

Inherited from FixtureInstance.getLayerFixtureConfig
- Defined in src/api/fixture.ts:395

getLayerFixtureConfigs

getLayerFixtureConfigs(): {
[layerId: string]: any;
}
Combines this fixtures configs from layer configs into an indexed-dictionary

Returns {
[layerId: string]: any;
}
Dictionary where key is the layer id and the value is this fixture's config for that layer
- [layerId: string]: any
Implementation of ExportSubFixture.getLayerFixtureConfigs

Inherited from FixtureInstance.getLayerFixtureConfigs
- Defined in src/api/fixture.ts:406

handlePanelWidths

handlePanelWidths(panels): void
If the panelWidth property is provided, handle default and specified panel widths for the given fixture.
Parameters
- panels: string[]
  
  list of panel names for the calling fixture
Returns void
Implementation of ExportSubFixture.handlePanelWidths

Inherited from FixtureInstance.handlePanelWidths
- Defined in src/api/fixture.ts:438

`Optional` initialized

initialized(): void
Returns void
Implementation of ExportSubFixture.initialized

Inherited from FixtureInstance.initialized
- Defined in src/api/fixture.ts:373

make

make(options): Promise<Group>
Creates an export image and returns it.

Memberof
ExportSubFixture
Parameters
- options: any
  
  fixture config options or any other options that a sub fixture accepts
Returns Promise<Group>
Implementation of ExportSubFixture.make
- Defined in src/fixtures/export-legend/index.ts:57

mount

mount(component, __namedParameters?): {
    destroy: (() => void);
    el: any;
    vNode: any;
}
Helper with programatically creating a component in Vue 3 (replaces the deprecated Vue.extend)

Memberof
FixtureInstance
Parameters
- component: Component<any, any, any, ComputedOptions, MethodOptions>
- __namedParameters: any = {}
Returns {
    destroy: (() => void);
    el: any;
    vNode: any;
}
- destroy: (() => void)
  - - (): void
    - Returns void
- el: any
- vNode: any
Implementation of ExportSubFixture.mount

Inherited from FixtureInstance.mount
- Defined in src/api/fixture.ts:349

remove

remove(): default
Removes the specified fixture from R4MP instance. This is a proxy to rInstance.fixture.remove(...).

Memberof
FixtureInstance

Returns default
Implementation of ExportSubFixture.remove

Inherited from FixtureInstance.remove
- Defined in src/api/fixture.ts:304

`Optional` removed

removed(): void
Returns void
Implementation of ExportSubFixture.removed

Inherited from FixtureInstance.removed
- Defined in src/api/fixture.ts:372

`Optional` terminated

terminated(): void
Returns void
Implementation of ExportSubFixture.terminated

Inherited from FixtureInstance.terminated
- Defined in src/api/fixture.ts:374

`Static` updateBaseToInstance

updateBaseToInstance(value, id, $iApi): FixtureInstance
Adds missing functions and properties to the object implementing FixtureBase interface. This is only needed for external fixtures as they can't inherit from FixtureInstance.

TODO: If you know a better way to deep-mixin props/getters/functions from a class into another class instance, please tell me. I honestly don't know 🤷‍♂️.

Static

Memberof
FixtureInstance
Parameters
- value: FixtureBase
- id: string
- $iApi: InstanceAPI
Returns FixtureInstance
Inherited from FixtureInstance.updateBaseToInstance
- Defined in src/api/fixture.ts:248

Class default

Export

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Memberof

Parameters

id: string

iApi: InstanceAPI

Returns default

Properties

Readonly $iApi

Memberof

Readonly id

Memberof

Accessors

$element

Returns App<Element>

$vApp

Memberof

Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

config

Memberof

Returns any

Methods

Private _getLayerTreeIds

Memberof

Parameters

rootLayer: LayerInstance

Returns number[]

Private _makeChunkItems

Memberof

Parameters

symbologyStack: LegendSymbology[]

segmentWidth: number

Returns Promise<Group>[]

Private _makeColumns

Memberof

Parameters

items: Group[]

columnWidth: number

columns: number

Returns Group

Private _makeSegmentChunks

Memberof

Parameters

ids: number[]

layer: LayerInstance

segmentWidth: number

Returns Promise<SegmentChunk>[]

Private _makeSegments

Memberof

Parameters

layers: LayerInstance[]

segmentWidth: number

Returns Promise<Segment>[]

Optional added

Returns void

extend

Memberof

Parameters

vueComponent: Record<string, any>

Optional options: ComponentOptions<{}, any, any, any, any, any, any, any, any> = {}

Returns any

getLayerFixtureConfig

Parameters

layerId: string

Returns any

getLayerFixtureConfigs

Returns { [layerId: string]: any; }

[layerId: string]: any

handlePanelWidths

Parameters

panels: string[]

`Readonly` $iApi

`Readonly` id

`Private` _getLayerTreeIds

`Private` _makeChunkItems

`Private` _makeColumns

`Private` _makeSegmentChunks

`Private` _makeSegments

`Optional` added

`Optional` options: ComponentOptions<{}, any, any, any, any, any, any, any, any> = {}

Returns {
[layerId: string]: any;
}

`Optional` initialized

Returns {
destroy: (() => void);
el: any;
vNode: any;
}

`Optional` removed

`Optional` terminated

`Static` updateBaseToInstance