INPUT_OBJECT

SaveComponentViewInput

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

link GraphQL Schema definition

1input SaveComponentViewInput {
5
2# The developer configured height of the extension as a ratio relative to it's
3# width.
4aspectHeight: Int
16
6# Specifies the width of a component extension in relation to it's targetHeight
7# and aspectRatioY.
8#
9# NOTE: targetHeight and aspectRatio will replace aspectHeight and aspectWidth.
10#
11# however, since both will be used for a short time during the rollout of the new
12# UI,
13#
14# aspectWidth and aspectHeight will not be deprecated until later.
15aspectRatioX: Int!
27
17# Specifies the height of a component extension in relation to it's targetHeight
18# and aspectRatioX.
19#
20# NOTE: targetHeight and aspectRatio will replace aspectHeight and aspectWidth,
21#
22# however, since both will be used for a short time during the rollout of the new
23# UI,
24#
25# aspectWidth and aspectHeight will not be deprecated until later.
26aspectRatioY: Int!
31
28# The developer configured width of the extension as a ratio relative to it's
29# height.
30aspectWidth: Int
36
32# Specifies whether to automatically scale the extension iframe using css zoom as
33# the video
34# player dimensions change.
35hasAutoscale: Boolean
41
37# Specifies whether CSS zooming should be applied to the CE container, creating a
38# consistent
39# size of 1024 pixels along the long edge of the component. Default: true.
40hasZoom: Boolean
45
42# If Autoscale is true, this indicates the baseline width of the extension.
43# This fields is optional, but is required if hasAutoscale is true.
44scalePixels: Int
50
46# Size of the long edge of the Component Extension, relative to the length of the
47# corresponding
48# interactable dimension of the video.
49size: Float
62
51# The percentage of the available space (0-100) (between the top and bottom player
52# controls)
53# that the extension aims to consume.
54#
55# NOTE: targetHeight and aspectRatio will replace aspectHeight and aspectWidth,
56#
57# however, since both will be used for a short time during the rollout of the new
58# UI,
59#
60# aspectWidth and aspectHeight will not be deprecated until later.
61targetHeight: Int!
65
63# Relative path of the HTML file to load for this view.
64viewerPath: String!
70
66# If hasZoom is set to true, specify the effective CSS zoom to apply to the long
67# edge of the CE.
68# Default: 1024.
69zoomPixels: Int
71}