OBJECT

ComponentView

The view configuration of an extension if the component anchor is supported.

link GraphQL Schema definition

1type ComponentView implements ExtensionView {
2
3# Specifies the width of a component extension in relation to it's targetHeight
4# and aspectRatioY.
5#
6# NOTE: targetHeight and aspectRatio will replace aspectHeight and aspectWidth.
7#
8# however, since both will be used for a short time during the rollout of the new
9# UI,
10#
11# aspectWidth and aspectHeight will not be deprecated until later.
12aspectRatioX: Int!
13
14# Specifies the height of a component extension in relation to it's targetHeight
15# and aspectRatioX.
16#
17# NOTE: targetHeight and aspectRatio will replace aspectHeight and aspectWidth,
18#
19# however, since both will be used for a short time during the rollout of the new
20# UI,
21#
22# aspectWidth and aspectHeight will not be deprecated until later.
23aspectRatioY: Int!
24
25# Specifies whether or not the extension has the ability to link to external
26# websites.
27canLinkExternalContent: Boolean!
28
29# Specifies whether to automatically scale the extension iframe using css zoom as
30# the video
31# player dimensions change.
32hasAutoscale: Boolean!
33
34# If Autoscale is true, this indicates the baseline width of the extension.
35# This fields is optional, but is required if hasAutoscale is true.
36scalePixels: Int
37
38# The percentage of the available space (0-100) (between the top and bottom player
39# controls)
40# that the extension aims to consume.
41#
42# NOTE: targetHeight and aspectRatio will replace aspectHeight and aspectWidth,
43#
44# however, since both will be used for a short time during the rollout of the new
45# UI,
46#
47# aspectWidth and aspectHeight will not be deprecated until later.
48targetHeight: Int!
49
50# Relative path of the HTML file to load for this view, used by devsite to specify
51# the layout of assets.
52viewerPath: String!
53
54# The URL which should be loaded in for the extension.
55viewerURL: String!
56
57}