Function GraffitiGet

The Graffiti.get method as a reactive renderless component for use in Vue templates.

Its props and slots are identical to the arguments and return values of the composable useGraffitiGet.

  • GraffitiGet<Schema extends JSONSchema>(
        __VLS_props: {
            autopoll?: boolean;
            schema: Schema;
            session?: null | GraffitiSession;
            url: string | GraffitiObjectUrl;
        } & VNodeProps & AllowedComponentProps & ComponentCustomProps,
        __VLS_ctx?: {
            attrs: any;
            emit: {};
            slots: Readonly<
                {
                    default(
                        props: {
                            isInitialPolling: boolean;
                            object: undefined | null | GraffitiObject<Schema>;
                            poll: () => void;
                        },
                    ): any;
                },
            > & {
                default(
                    props: {
                        isInitialPolling: boolean;
                        object: undefined | null | GraffitiObject<Schema>;
                        poll: () => void;
                    },
                ): any;
            };
        },
        __VLS_expose?: (exposed: ShallowUnwrapRef<{}>) => void,
        __VLS_setup?: Promise<
            {
                attrs: any;
                emit: {};
                props: {
                    autopoll?: boolean;
                    schema: Schema;
                    session?: null
                    | GraffitiSession;
                    url: string | GraffitiObjectUrl;
                } & VNodeProps & AllowedComponentProps & ComponentCustomProps;
                slots: Readonly<
                    {
                        default(
                            props: {
                                isInitialPolling: boolean;
                                object: undefined | null | GraffitiObject<Schema>;
                                poll: () => void;
                            },
                        ): any;
                    },
                > & {
                    default(
                        props: {
                            isInitialPolling: boolean;
                            object: undefined | null | GraffitiObject<Schema>;
                            poll: () => void;
                        },
                    ): any;
                };
                expose(exposed: ShallowUnwrapRef<{}>): void;
            },
        >,
    ): VNode<RendererNode, RendererElement, { [key: string]: any }> & {
        __ctx?: {
            attrs: any;
            emit: {};
            props: {
                autopoll?: boolean;
                schema: Schema;
                session?: null | GraffitiSession;
                url: string | GraffitiObjectUrl;
            } & VNodeProps & AllowedComponentProps & ComponentCustomProps;
            slots: Readonly<
                {
                    default(
                        props: {
                            isInitialPolling: boolean;
                            object: undefined | null | GraffitiObject<Schema>;
                            poll: () => void;
                        },
                    ): any;
                },
            > & {
                default(
                    props: {
                        isInitialPolling: boolean;
                        object: undefined | null | GraffitiObject<Schema>;
                        poll: () => void;
                    },
                ): any;
            };
            expose(exposed: ShallowUnwrapRef<{}>): void;
        };
    }

    Type Parameters

    • Schema extends JSONSchema

    Parameters

    • __VLS_props: {
          autopoll?: boolean;
          schema: Schema;
          session?: null | GraffitiSession;
          url: string | GraffitiObjectUrl;
      } & VNodeProps & AllowedComponentProps & ComponentCustomProps
    • Optional__VLS_ctx: {
          attrs: any;
          emit: {};
          slots: Readonly<
              {
                  default(
                      props: {
                          isInitialPolling: boolean;
                          object: undefined | null | GraffitiObject<Schema>;
                          poll: () => void;
                      },
                  ): any;
              },
          > & {
              default(
                  props: {
                      isInitialPolling: boolean;
                      object: undefined | null | GraffitiObject<Schema>;
                      poll: () => void;
                  },
              ): any;
          };
      }
    • Optional__VLS_expose: (exposed: ShallowUnwrapRef<{}>) => void
    • Optional__VLS_setup: Promise<
          {
              attrs: any;
              emit: {};
              props: {
                  autopoll?: boolean;
                  schema: Schema;
                  session?: null
                  | GraffitiSession;
                  url: string | GraffitiObjectUrl;
              } & VNodeProps & AllowedComponentProps & ComponentCustomProps;
              slots: Readonly<
                  {
                      default(
                          props: {
                              isInitialPolling: boolean;
                              object: undefined | null | GraffitiObject<Schema>;
                              poll: () => void;
                          },
                      ): any;
                  },
              > & {
                  default(
                      props: {
                          isInitialPolling: boolean;
                          object: undefined | null | GraffitiObject<Schema>;
                          poll: () => void;
                      },
                  ): any;
              };
              expose(exposed: ShallowUnwrapRef<{}>): void;
          },
      >

    Returns VNode<RendererNode, RendererElement, { [key: string]: any }> & {
        __ctx?: {
            attrs: any;
            emit: {};
            props: {
                autopoll?: boolean;
                schema: Schema;
                session?: null | GraffitiSession;
                url: string | GraffitiObjectUrl;
            } & VNodeProps & AllowedComponentProps & ComponentCustomProps;
            slots: Readonly<
                {
                    default(
                        props: {
                            isInitialPolling: boolean;
                            object: undefined | null | GraffitiObject<Schema>;
                            poll: () => void;
                        },
                    ): any;
                },
            > & {
                default(
                    props: {
                        isInitialPolling: boolean;
                        object: undefined | null | GraffitiObject<Schema>;
                        poll: () => void;
                    },
                ): any;
            };
            expose(exposed: ShallowUnwrapRef<{}>): void;
        };
    }

Settings

Member Visibility